vars

Documentation

Overview

Package vars 提供了一些公共的函数、结构体及代码级别的设置项。

Index

• Constants
• func CommitHash() string
• func Version() string

Constants

const (
	API        = "@api"
	APIDoc     = "@apidoc"
	APILicense = "@apiLicense"
	APIVersion = "@apiVersion"
	APIParam   = "@apiParam"
	APIQuery   = "@apiQuery"
	APIHeader  = "@apiHeader"
	APISuccess = "@apiSuccess"
	APIError   = "@apiError"
	APIRequest = "@apiRequest"
	APIBaseURL = "@apiBaseURL"
	APIGroup   = "@apiGroup"
	APIIgnore  = "@apiIgnore"
	APIContent = "@apiContent"
	APIExample = "@apiExample"
)

所有标签的定义

const (
	// 程序的正式名称
	Name = "apidoc"

	// 源码仓库地址
	RepoURL = "https://github.com/tanxiaolong/apidoc"

	// 官网
	OfficialURL = "http://apidoc.tools"

	// 配置文件名称。
	ConfigFilename = ".apidoc.yaml"

	// 默认的文档标题
	DefaultTitle = "APIDOC"

	// 默认的分组名称，在不指定分组名称的时候，系统会给其加到此分组中。
	DefaultGroupName = "index"

	// 默认的语言，目前仅能保证简体中文是最新的。
	// 需要保证存在于 locale.locales 中，否则运行时会报错。
	DefaultLocale = "zh-Hans"

	// 两个性能文件的名称
	PprofCPU = "cpu"
	PprofMem = "mem"

	// 生成的 JSON 数据存放的目录
	JSONDataDirName = "data"

	// JSON 生成的 JSON 文件，缩进量
	JSONIndent = 2

	// 页面信息的文件名
	PageFileName = "page"

	// 组文件的前缀，有前缀，不会与现有文件重名
	GroupFilePrefix = "group_"

	// 控制台的颜色
	InfoColor = colors.Green
	WarnColor = colors.Cyan
	ErroColor = colors.Red
)

一些公用的常量

Functions

func CommitHash

func CommitHash() string

CommitHash Git 上最后的提交记录 hash 值。

func Version

func Version() string

Version 完整的版本号