api

Documentation

Index

• Constants
• Variables
• type Router
  • func SetupOpenAPI(cfg *conf.AppConf, engine *gin.Engine, datasource *data.DataSource) (Router, error)

Constants

const (
	BasePath = "/open/v1"
	DocPath  = "/open/v1/doc"
)

Variables

var ApiProviderSet = wire.NewSet(
	user.UserRouterSet,
	wire.Struct(new(Router), "*"),
)

var Config = &ginSwagger.Config{
	URL:                      "doc.json",
	DocExpansion:             "list",
	InstanceName:             "openapi",
	Title:                    "OpenAPI",
	DefaultModelsExpandDepth: 0,
	DeepLinking:              true,
	PersistAuthorization:     false,
	Oauth2DefaultClientID:    "",
}

Types

type Router

type Router struct {
	User user.APIRouter
}

func SetupOpenAPI

func SetupOpenAPI(cfg *conf.AppConf, engine *gin.Engine, datasource *data.DataSource) (Router, error)

SetupOpenAPI initializes app open api router configuration