diff --git a/README.md b/README.md index dbd3de1..7e07033 100644 --- a/README.md +++ b/README.md @@ -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 @@ -160,7 +161,7 @@ You can configure Swagger using different configuration options func main() { r := gin.New() - ginSwagger.WrapHandler(swaggerFiles.Handler, + ginSwagger.WrapHandler(swaggerfiles.Handler, ginSwagger.URL("http://localhost:8080/swagger/doc.json"), ginSwagger.DefaultModelsExpandDepth(-1)) @@ -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. |