gin

README

Gin Server

Usage

package main

import (
	"github.com/gin-gonic/gin"
	"github.com/go-kratos/kratos/v2"

	ginS "github.com/go-kratos-ecosystem/components/v2/gin"
)

func main() {
	gs := ginS.NewServer(
		gin.Default(),
		ginS.Addr(":8080"),
	)

	gs.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong",
		})
	})

	app := kratos.New(
		kratos.Server(gs),
	)

	err := app.Run()
	if err != nil {
		panic(err)
	}
}

Documentation

Index

• type Option
  • func Addr(addr string) Option
  • func Middleware(middlewares ...gin.HandlerFunc) Option
  • func WithAddr(addr string) Option
• type Server
  • func NewServer(e *gin.Engine, opts ...Option) *Server
  • func (s *Server) Start(_ context.Context) error
  • func (s *Server) Stop(ctx context.Context) error

Types

type Option

type Option func(*Server)

func Addr

func Addr(addr string) Option

func Middleware

func Middleware(middlewares ...gin.HandlerFunc) Option

func WithAddr

func WithAddr(addr string) Option

Deprecated: use Addr

type Server

type Server struct {
	*gin.Engine
	// contains filtered or unexported fields
}

func NewServer

func NewServer(e *gin.Engine, opts ...Option) *Server

func (*Server) Start

func (s *Server) Start(_ context.Context) error

func (*Server) Stop

func (s *Server) Stop(ctx context.Context) error