cmfx

README

cmfx

目录结构

• pkg 一些通用的包；
• modules 通用模块，模块只能是单例；
• locales cmfx 用到的本地化内容；

Documentation

Index

• Constants
• func AddProblems(p *server.Problems)
• func Init(cleanup func(), f ...func() error)

Constants

const (
	BadRequest              = "40000"
	BadRequestInvalidParam  = "40001"
	BadRequestInvalidQuery  = "40002"
	BadRequestInvalidHeader = "40003"
	BadRequestInvalidBody   = "40004"
)

定义可用的错误代码

const (
	Unauthorized                   = "40100"
	UnauthorizedInvalidState       = "40101"
	UnauthorizedInvalidToken       = "40102"
	UnauthorizedInvalidPassword    = "40103"
	UnauthorizedInvalidAccount     = "40104"
	UnauthorizedNeedChangePassword = "40105"

	// 可注册的状态，比如 OAuth2 验证，如果未注册，返回一个 ID 可用以注册。
	UnauthorizedRegistrable = "40106"
)

401

const (
	Forbidden                    = "40300"
	ForbiddenStateNotAllow       = "40301"
	ForbiddenCaNotDeleteYourself = "40302"
)

403

const Version = "0.6.0"

Version 表示当前框架的版本

Functions

func AddProblems

func AddProblems(p *server.Problems)

func Init

func Init(cleanup func(), f ...func() error)

Init 执行一系列的初始化操作

依次执行 f 中的函数，碰到第一个返回错误的函数时即退出整个流程，并执行 cleanup 进行清理操作。

cleanup 清理操作，只有当 f 出错时，才会执行 cleanup。