go/golang-saas-starter-kit
1
0
Fork 0
mirror of https://github.com/raseels-repos/golang-saas-starter-kit.git synced 2025-08-08 22:36:41 +02:00
Code Issues Releases Activity

forked swaggo/swag and added caching to reduce build times

Browse Source
This commit is contained in:
Lee Brown
2019-08-07 20:19:09 -08:00
parent 195754432c
commit b387ccb827
13 changed files with 90 additions and 292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
internal/mid/saas-swagger/README.md
View File

@ -12,14 +12,14 @@ saas 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://github.com/geeks-accelerator/swag#declarative-comments-format).
2. Download [Swag](https://github.com/swaggo/swag) for Go by using:
2. Download [Swag](https://github.com/geeks-accelerator/swag) for Go by using:
```sh
$ go get github.com/swaggo/swag/cmd/swag
$ go get github.com/geeks-accelerator/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`).
3. Run the [Swag](https://github.com/geeks-accelerator/swag) in your Go project root folder which contains `main.go` file, [Swag](https://github.com/geeks-accelerator/swag) will parse comments and generate required files(`docs` folder and `docs/doc.go`).
```sh_ "github.com/swaggo/echo-swagger/v2/example/docs"
$ swag init
```