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

[WIP] fix: fix 'See Declarative Comments Format' link (#19) 

* fix: fix 'See Declarative Comments Format' link

* fix: fix import example lib
This commit is contained in:
Eason Lin 2018-04-14 02:04:08 +08:00 committed by pei
parent 1510a6d46f
commit 8cf3fa9932
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -11,7 +11,7 @@ gin middleware to automatically generate RESTful API documentation with Swagger
## Usage
### Start using it
1. Add comments to your API source code, [See Declarative Comments Format](https://github.com/swaggo/swag#declarative-comments-format).
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

2
example/api/api.go
View File

@ -3,7 +3,7 @@ package api
import (
"fmt"
"github.com/gin-gonic/gin"
"github.com/swaggo/swag/example/simple/web"
"github.com/swaggo/swag/example/basic/web"
)
//