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

fixed typo

This commit is contained in:
RadientBrain 2023-02-26 19:28:56 +05:30
parent 0613417b2f
commit e705a07f0c
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -25,9 +25,9 @@ Starting in Go 1.17, installing executables with `go get` is deprecated. `go ins
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-peoject-name`),
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-peoject-name/docs`.
at `~/root/go-project-name/docs`.
```sh
swag init
@ -150,6 +150,7 @@ Demo project tree, `swag init` is run at relative `.`
```
## Multiple APIs
This feature was introduced in swag v1.7.9
## Configuration
@ -175,5 +176,5 @@ func main() {
| 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. |
| 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. |