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

docs: starting in Go 1.17, use `go install`. (#210)

This commit is contained in:
stepbystep2 2022-05-12 14:21:43 +08:00 committed by GitHub
parent bdcc4ec34b
commit eb1f2ffcfc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,6 +1,6 @@
# gin-swagger
gin middleware to automatically generate RESTFUL API documentation with Swagger 2.0.
gin middleware to automatically generate RESTful API documentation with Swagger 2.0.
[![Build Status](https://github.com/swaggo/gin-swagger/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/features/actions)
[![Codecov branch](https://img.shields.io/codecov/c/github/swaggo/gin-swagger/master.svg)](https://codecov.io/gh/swaggo/gin-swagger)
@ -19,6 +19,12 @@ gin middleware to automatically generate RESTFUL API documentation with Swagger
go get -u github.com/swaggo/swag/cmd/swag
```
Starting in Go 1.17, installing executables with `go get` is deprecated. `go install` may be used instead:
```sh
go install github.com/swaggo/swag/cmd/swag
```
3. Run the [Swag](https://github.com/swaggo/swag) at your Go project root path(for instance `~/root/go-peoject-name`),
[Swag](https://github.com/swaggo/swag) will parse comments and generate required files(`docs` folder and `docs/doc.go`)
at `~/root/go-peoject-name/docs`.