安裝swagger
此處只針對win敛惊,其他系統(tǒng)安裝方法可至官網(wǎng)查看弦悉。
go get github.com/go-swagger/go-swagger
//如果install出現(xiàn)pakage找不到富玷,進行g(shù)o get github.com/go-swagger/go-swagger/cmd/swagger即可
go install github.com/go-swagger/go-swagger/cmd/swagger
生成json文檔注釋文件
在定義接口方法之前加入swagger注釋
// swagger:operation POST /machine/{type} machine createmachine
// ---
// summary: List the repositories owned by the given author.
// description: If author length is between 6 and 8, Error Not Found (404) will be returned.
// parameters:
// - name: author
// in: path
// description: username of author
// type: string
// required: true
func Test(w http.ResponseWriter, r *http.Request) {
.....
}
然后執(zhí)行生成文檔json命令
swagger generate spec -o ./swagger.json
此命令會找到main.go入口文件耘斩,然后遍歷所有源碼文件磁携,解析然后生成swagger.json文件
把文檔文件變?yōu)榭梢暬疷I
從 swagger-ui庫下載dist文件夾到自己的項目中酌摇,并更名為swagger。把swagger中的index.html的url改成./swagger.json
將生成的swagger.json作為一個fileServer路由加入到server中
//component/swagger為dist的目錄
httpMux.Handle("/swagger/", http.StripPrefix("/swagger/", http.FileServer(http.Dir("component/swagger"))))
最后訪問相應(yīng)路徑即可http://x.x.x.x:xxxx/swagger/index.html