apidoc

Documentation

Index

• Constants
• Variables
• func DefinitionsApi(definitions map[string]spec.Schema, v interface{})
• func DocList(w http.ResponseWriter, r *http.Request)
• func GetDoc(realPath, modName string) *spec.Swagger
• func Markdown(w http.ResponseWriter, r *http.Request)
• func NilDoc()
• func OpenApi(mux *http.ServeMux, filePath string)
• func Swagger(w http.ResponseWriter, r *http.Request)
• func WriteToFile(realPath, modName string)

Constants

const MarkDownEXT = ".apidoc.md"

const SwaggerEXT = ".swagger.json"

const TypeMarkdown = "markdown"

const TypeSwagger = "swagger"

Variables

var ApiDocDir = "./apidoc/"

var Doc *spec.Swagger

var UriPrefix = "/api-doc"

目录结构 ./api/mod/mod.swagger.json ./api/mod/mod.apidoc.md 请求路由 /api-doc /api-doc/swagger/mod/mod.swagger.json /api-doc/markdown/mod/mod.apidoc.md

Functions

func DefinitionsApi

func DefinitionsApi(definitions map[string]spec.Schema, v interface{})

func DocList

func DocList(w http.ResponseWriter, r *http.Request)

func GetDoc

func GetDoc(realPath, modName string) *spec.Swagger

参数为路径和格式

func Markdown

func Markdown(w http.ResponseWriter, r *http.Request)

func NilDoc

func NilDoc()

func OpenApi

func OpenApi(mux *http.ServeMux, filePath string)

func Swagger

func Swagger(w http.ResponseWriter, r *http.Request)

func WriteToFile

func WriteToFile(realPath, modName string)