suguo
/
gin-swagger
mirror of https://github.com/swaggo/gin-swagger.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc(readme): add the -u flag (#32)

This commit is contained in:
Eason Lin 2018-09-19 13:22:14 +08:00 committed by pei
parent e18d29b078
commit 6192cec7d2
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -14,7 +14,7 @@ gin middleware to automatically generate RESTful API documentation with Swagger
1. Add comments to your API source code, [See Declarative Comments Format](https://swaggo.github.io/swaggo.io/declarative_comments_format/).
2. Download [Swag](https://github.com/swaggo/swag) for Go by using:
```sh
$ go get github.com/swaggo/swag/cmd/swag
$ go get -u github.com/swaggo/swag/cmd/swag
```
3. Run the [Swag](https://github.com/swaggo/swag) in your Go project root folder which contains `main.go` file, [Swag](https://github.com/swaggo/swag) will parse comments and generate required files(`docs` folder and `docs/doc.go`).