forked from swag and developed for yapi feature.
WARNING: This is still in beta stage, use with care!
package main
type People struct {
Name string `json:"name" mock:"@string(\"lower\",5)"`
Age int `json:"age" mock:"@integer(0,100)"`
Birthday string `json:"birthday" mock:"@datetime(\"yyyy-MM-dd A HH:mm:ss\")"`
}-
upload swagger.json to yapi server.
-
adapt mock.js.
- To install it, either download a version from the release page, use
go install/go get.
go get -u https://github.com/WaltCuller/swag-yapi-
Add comments to your API source code. See Declarative Comments Format.
-
For response struct, swag-yapi use the customize tag:
mock. See mock.js -
Add toml config to define the yapi server address and configuration.
[swagger]
type = "swagger" # yapi upload type
token = "xxxxx" # yapi token
merge = "normal" # merge type
server = "xxxxxx" # yapi server address
file_path = "docs/swagger/swagger.json" # swagger.json file path-
After added comments and tags, run
swag-yapi initlikeswag initin the project's root folder which contains themain.gofile. This will parse your comments and generate the require files(docsfolder anddocs/docs.go) -
use
swag-yapi uploadwith option-cto get the config and upload swagger.json to your yapi server.
$ swag-yapi -h
NAME:
swag-yapi - Automatically generate RESTful API documentation with Swagger 2.0 for Go.
USAGE:
swag-yapi [global options] command [command options] [arguments...]
VERSION:
v1.7.0_0.0.1
COMMANDS:
init, i Create docs.go
upload, u upload swagger.json to yapi
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help (default: false)
--version, -v print the version (default: false)