docgen

Documentation

Index

• Constants
• func GenDoc(ctx context.Context, docName, docFilePath string, maxdepth int, ...)
• func GenModuleDoc(ctx context.Context, moduleName, moduleUri string, paramMap map[string]string, ...) string
• func SetupModelPath(path string)
• type DefaultServiceResponse
  • func (r *DefaultServiceResponse) GetCode() int
  • func (r *DefaultServiceResponse) GetMsg() string
  • func (r *DefaultServiceResponse) SetRequrieUri(uri string)
• type ServiceResponse

Constants

const (
	PARAM_MODULE_METHOD   = "moduleMethod"  // POST:application/json
	PARAM_REQ_MODEL_PATH  = "reqModelPath"  // request model file path
	PARAM_RESP_MODEL_PATH = "respModelPath" // response model file path
	PARAM_REQ_REMARK      = "reqRemark"     // request custom remark
	PARAM_RESP_REMARK     = "respRemark"    // response custom remark
)

optional

const (
	MODEL_TYPE_REGX = `(?U)type\s+%s\s+struct\s+{`
)

Functions

func GenDoc

func GenDoc(ctx context.Context, docName, docFilePath string, maxdepth int, moduleDocs string)

func GenModuleDoc

func GenModuleDoc(ctx context.Context, moduleName, moduleUri string, paramMap map[string]string, reqTypeNames []string, reqCase interface{},
	respTypeNames []string, respCases ...interface{}) string

func SetupModelPath

func SetupModelPath(path string)

Types

type DefaultServiceResponse

type DefaultServiceResponse struct {
	Code int         `json:"code"`
	Msg  string      `json:"msg"`
	Uri  string      `json:"uri,omitempty"`
	Data interface{} `json:"data"`
}

func (*DefaultServiceResponse) GetCode

func (r *DefaultServiceResponse) GetCode() int

func (*DefaultServiceResponse) GetMsg

func (r *DefaultServiceResponse) GetMsg() string

func (*DefaultServiceResponse) SetRequrieUri

func (r *DefaultServiceResponse) SetRequrieUri(uri string)

type ServiceResponse

type ServiceResponse interface {
	GetCode() int
	GetMsg() string
	SetRequrieUri(string)
}