Documentation ¶
Index ¶
Constants ¶
View Source
const ( PROJECT_NAME = "Gin-Docs" PROJECT_VERSION = Version )
View Source
const Version = "0.2.0"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiDoc ¶
func (ApiDoc) OfflineHtml ¶ added in v0.2.0
func (ApiDoc) OfflineMarkdown ¶ added in v0.2.0
func (ApiDoc) OnlineHtml ¶ added in v0.2.0
type Config ¶
type Config struct { // Title, default `API Doc` Title string // Version, default `1.0.0` Version string // Description Description string // Custom CDN CSS Template CdnCssTemplate string // Custom CDN JS Template CdnJsTemplate string // Custom url prefix, default `/docs/api` UrlPrefix string // No document text, default `No documentation found for this API` NoDocText string // Enable document pages, default `true` Enable bool // Using CDN, default `false` Cdn bool // API package name to exclude Exclude []string // Methods allowed to be displayed, default `[]string{"GET", "POST", "PUT", "DELETE", "PATCH"}` MethodsList []string // SHA256 encrypted authorization password, e.g. here is admin // echo -n admin | shasum -a 256 // `8c6976e5b5410415bde908bd4dee15dfb167a9c873fc4bb8a81f6f2ab448a918` PasswordSha2 string // Enable markdown processing for all documents, default `true` AllMd bool }
type KVMapSlice ¶
type KVMapSlice []KVMap
func (KVMapSlice) Len ¶
func (ks KVMapSlice) Len() int
func (KVMapSlice) Less ¶
func (ks KVMapSlice) Less(i, j int) bool
func (KVMapSlice) Swap ¶
func (ks KVMapSlice) Swap(i, j int)
Source Files ¶
Click to show internal directories.
Click to hide internal directories.