gopkg/gin-swagger
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
stepbystep2
2022-05-12 14:21:43 +08:00
committed by GitHub
parent bdcc4ec34b
commit eb1f2ffcfc
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -1
View File
@@ -1,6 +1,6 @@
# gin-swagger # 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) [![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) [![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 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`), 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`) [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`. at `~/root/go-peoject-name/docs`.