api

package

v0.0.0-...-3839eb7 Latest Latest Go to latest Published: Mar 5, 2024 License: MIT Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/dstgo/backend-layout

Documentation ¶

Index ¶

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

Constants ¶

View Source

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

Variables ¶

View Source

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

View Source

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

Functions ¶

This section is empty.

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
docs Package docs Code generated by swaggo/swag at 2024-03-05 22:17:44.8864028 +0800 CST m=+2.739990801.	Package docs Code generated by swaggo/swag at 2024-03-05 22:17:44.8864028 +0800 CST m=+2.739990801.
user

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL