app

Documentation

Overview

Package app 生成swagger文档

文档规则请参考：https://github.com/swaggo/swag#declarative-comments-format

使用方式：

go get -u github.com/swaggo/swag/cmd/swag
swag init --generalInfo ./internal/app/swagger.go --output ./internal/app/swagger

Index

• func Init(ctx context.Context, opts ...Option) (func(), error)
• func InitCaptcha()
• func InitHTTPServer(ctx context.Context, handler http.Handler) func()
• func InitLogger() (func(), error)
• func InitMonitor(ctx context.Context)
• func Run(ctx context.Context, opts ...Option) error
• func SetHandler(server server.Server) (func(), error)
• type Option
  • func SetConfigFile(s string) Option
  • func SetMenuFile(s string) Option
  • func SetModelFile(s string) Option
  • func SetVersion(s string) Option
  • func SetWWWDir(s string) Option

Functions

func Init

func Init(ctx context.Context, opts ...Option) (func(), error)

Init 应用初始化

func InitCaptcha

func InitCaptcha()

InitCaptcha 初始化图形验证码

func InitHTTPServer

func InitHTTPServer(ctx context.Context, handler http.Handler) func()

InitHTTPServer 初始化http服务

func InitLogger

func InitLogger() (func(), error)

InitLogger 初始化日志模块

func InitMonitor

func InitMonitor(ctx context.Context)

InitMonitor 初始化服务监控

func Run

func Run(ctx context.Context, opts ...Option) error

Run 运行服务

func SetHandler

func SetHandler(server server.Server) (func(), error)

Types

type Option

type Option func(*options)

Option 定义配置项

func SetConfigFile

func SetConfigFile(s string) Option

SetConfigFile 设定配置文件

func SetMenuFile

func SetMenuFile(s string) Option

SetMenuFile 设定菜单数据文件

func SetModelFile

func SetModelFile(s string) Option

SetModelFile 设定casbin模型配置文件

func SetVersion

func SetVersion(s string) Option

SetVersion 设定版本号

func SetWWWDir

func SetWWWDir(s string) Option

SetWWWDir 设定静态站点目录