Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swaggo/gin-swagger
gin middleware to automatically generate RESTful API documentation with Swagger 2.0.
https://github.com/swaggo/gin-swagger
gin gin-middleware gin-swagger golang middleware swagger
Last synced: 11 days ago
JSON representation
gin middleware to automatically generate RESTful API documentation with Swagger 2.0.
- Host: GitHub
- URL: https://github.com/swaggo/gin-swagger
- Owner: swaggo
- License: mit
- Created: 2017-06-22T00:45:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-19T14:02:14.000Z (7 months ago)
- Last Synced: 2024-04-19T15:28:17.615Z (7 months ago)
- Topics: gin, gin-middleware, gin-swagger, golang, middleware, swagger
- Language: Go
- Homepage:
- Size: 11.8 MB
- Stars: 3,558
- Watchers: 41
- Forks: 262
- Open Issues: 96
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome - swaggo/gin-swagger - middleware,gin-swagger,golang,middleware,swagger pushed_at:2024-05 star:3.8k fork:0.3k gin middleware to automatically generate RESTful API documentation with Swagger 2.0. (Go)
- awesome-luooooob - swaggo/gin-swagger - gin middleware to automatically generate RESTful API documentation with Swagger 2.0. (Go)
- go-awesome - gin-swagger - Swagger for gin (Open source library / Documentation)
- awesome-gin - swaggo/gin-swagger
README
# gin-swagger
gin middleware to automatically generate RESTful API documentation with Swagger 2.0.
[](https://github.com/features/actions)
[](https://codecov.io/gh/swaggo/gin-swagger)
[](https://goreportcard.com/report/github.com/swaggo/gin-swagger)
[](https://godoc.org/github.com/swaggo/gin-swagger)
[](https://github.com/swaggo/gin-swagger/releases)
## Usage
### Start using it
1. Add comments to your API source code, [See Declarative Comments Format](https://github.com/swaggo/swag/blob/master/README.md#declarative-comments-format).
2. Download [Swag](https://github.com/swaggo/swag) for Go by using:
```sh
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@latest
```
3. Run the [Swag](https://github.com/swaggo/swag) at your Go project root path(for instance `~/root/go-project-name`),
[Swag](https://github.com/swaggo/swag) will parse comments and generate required files(`docs` folder and `docs/doc.go`)
at `~/root/go-project-name/docs`.
```sh
swag init
```
4. Download [gin-swagger](https://github.com/swaggo/gin-swagger) by using:
```sh
go get -u github.com/swaggo/gin-swagger
go get -u github.com/swaggo/files
```
Import following in your code:
```go
import "github.com/swaggo/gin-swagger" // gin-swagger middleware
import "github.com/swaggo/files" // swagger embed files
```
### Canonical example:
Now assume you have implemented a simple api as following:
```go
// A get function which returns a hello world string by json
func Helloworld(g *gin.Context) {
g.JSON(http.StatusOK,"helloworld")
}
```
So how to use gin-swagger on api above? Just follow the following guide.
1. Add Comments for apis and main function with gin-swagger rules like following:
```go
// @BasePath /api/v1
// PingExample godoc
// @Summary ping example
// @Schemes
// @Description do ping
// @Tags example
// @Accept json
// @Produce json
// @Success 200 {string} Helloworld
// @Router /example/helloworld [get]
func Helloworld(g *gin.Context) {
g.JSON(http.StatusOK,"helloworld")
}
```
2. Use `swag init` command to generate a docs, docs generated will be stored at `docs/`.
3. import the docs like this:
I assume your project named `github.com/go-project-name/docs`.
```go
import (
docs "github.com/go-project-name/docs"
)
```
4. build your application and after that, go to http://localhost:8080/swagger/index.html ,you to see your Swagger UI.
5. The full code and folder relatives here:
```go
package main
import (
"github.com/gin-gonic/gin"
docs "github.com/go-project-name/docs"
swaggerfiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"
"net/http"
)
// @BasePath /api/v1
// PingExample godoc
// @Summary ping example
// @Schemes
// @Description do ping
// @Tags example
// @Accept json
// @Produce json
// @Success 200 {string} Helloworld
// @Router /example/helloworld [get]
func Helloworld(g *gin.Context) {
g.JSON(http.StatusOK,"helloworld")
}
func main() {
r := gin.Default()
docs.SwaggerInfo.BasePath = "/api/v1"
v1 := r.Group("/api/v1")
{
eg := v1.Group("/example")
{
eg.GET("/helloworld",Helloworld)
}
}
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
r.Run(":8080")
}
```
Demo project tree, `swag init` is run at relative `.`
```
.
├── docs
│ ├── docs.go
│ ├── swagger.json
│ └── swagger.yaml
├── go.mod
├── go.sum
└── main.go
```
## Project with Nested Directory
```
.
├── cmd
│ └── ginsimple
│ └── main.go
├── docs
│ ├── docs.go
│ ├── swagger.json
│ └── swagger.yaml
├── go.mod
├── go.sum
└── internal
├── handlers
│ ├── helloWorld.go
│ └── userHandler.go
└── models
├── profile.go
└── user.go
```
Inorder generate swagger docs for projects with nested directories run the following command
```bash
swag init -g ./cmd/ginsimple/main.go -o cmd/docs
```
`-o` will set the auto generated file to the specified path
## Multiple APIs
This feature was introduced in swag v1.7.9
## Configuration
You can configure Swagger using different configuration options
```go
func main() {
r := gin.New()
ginSwagger.WrapHandler(swaggerfiles.Handler,
ginSwagger.URL("http://localhost:8080/swagger/doc.json"),
ginSwagger.DefaultModelsExpandDepth(-1))
r.Run()
}
```
| Option | Type | Default | Description |
| ------------------------ | ------ | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| URL | string | "doc.json" | URL pointing to API definition |
| DocExpansion | string | "list" | Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing). |
| DeepLinking | bool | true | If set to true, enables deep linking for tags and operations. See the Deep Linking documentation for more information. |
| DefaultModelsExpandDepth | int | 1 | Default expansion depth for models (set to -1 completely hide the models). |
| InstanceName | string | "swagger" | The instance name of the swagger document. If multiple different swagger instances should be deployed on one gin router, ensure that each instance has a unique name (use the _--instanceName_ parameter to generate swagger documents with _swag init_). |
| PersistAuthorization | bool | false | If set to true, it persists authorization data and it would not be lost on browser close/refresh. |
| Oauth2DefaultClientID | string | "" | If set, it's used to prepopulate the _client_id_ field of the OAuth2 Authorization dialog. |