diff --git a/README.md b/README.md index 802016240..ab5354398 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # swag -🌍 *[English](README.md) ∙ [简体中文](README_zh-CN.md) ∙ [Português](README_pt.md)* +🌍 _[English](README.md) ∙ [简体中文](README_zh-CN.md) ∙ [Português](README_pt.md)_ @@ -13,39 +13,55 @@ [![Sponsors on Open Collective](https://opencollective.com/swag/sponsors/badge.svg)](#sponsors) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fswaggo%2Fswag.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fswaggo%2Fswag?ref=badge_shield) [![Release](https://img.shields.io/github/release/swaggo/swag.svg?style=flat-square)](https://github.com/swaggo/swag/releases) - Swag converts Go annotations to Swagger Documentation 2.0. We've created a variety of plugins for popular [Go web frameworks](#supported-web-frameworks). This allows you to quickly integrate with an existing Go project (using Swagger UI). ## Contents - - [Getting started](#getting-started) - - [Supported Web Frameworks](#supported-web-frameworks) - - [How to use it with Gin](#how-to-use-it-with-gin) - - [The swag formatter](#the-swag-formatter) - - [Implementation Status](#implementation-status) - - [Declarative Comments Format](#declarative-comments-format) - - [General API Info](#general-api-info) - - [API Operation](#api-operation) - - [Security](#security) - - [Examples](#examples) - - [Descriptions over multiple lines](#descriptions-over-multiple-lines) - - [User defined structure with an array type](#user-defined-structure-with-an-array-type) - - [Function scoped struct declaration](#function-scoped-struct-declaration) - - [Model composition in response](#model-composition-in-response) - - [Add a headers in response](#add-a-headers-in-response) - - [Use multiple path params](#use-multiple-path-params) - - [Example value of struct](#example-value-of-struct) - - [SchemaExample of body](#schemaexample-of-body) - - [Description of struct](#description-of-struct) - - [Use swaggertype tag to supported custom type](#use-swaggertype-tag-to-supported-custom-type) - - [Use global overrides to support a custom type](#use-global-overrides-to-support-a-custom-type) - - [Use swaggerignore tag to exclude a field](#use-swaggerignore-tag-to-exclude-a-field) - - [Add extension info to struct field](#add-extension-info-to-struct-field) - - [Rename model to display](#rename-model-to-display) - - [How to use security annotations](#how-to-use-security-annotations) - - [Add a description for enum items](#add-a-description-for-enum-items) - - [Generate only specific docs file types](#generate-only-specific-docs-file-types) - - [How to use Go generic types](#how-to-use-generics) -- [About the Project](#about-the-project) + +- [swag](#swag) + - [Contents](#contents) + - [Getting started](#getting-started) + - [swag cli](#swag-cli) + - [Supported Web Frameworks](#supported-web-frameworks) + - [How to use it with Gin](#how-to-use-it-with-gin) + - [The swag formatter](#the-swag-formatter) + - [Implementation Status](#implementation-status) +- [Declarative Comments Format](#declarative-comments-format) + - [General API Info](#general-api-info) + - [Using markdown descriptions](#using-markdown-descriptions) + - [API Operation](#api-operation) + - [Mime Types](#mime-types) + - [Param Type](#param-type) + - [Data Type](#data-type) + - [Security](#security) + - [Attribute](#attribute) + - [Available](#available) + - [Future](#future) + - [Examples](#examples) + - [Descriptions over multiple lines](#descriptions-over-multiple-lines) + - [User defined structure with an array type](#user-defined-structure-with-an-array-type) + - [Function scoped struct declaration](#function-scoped-struct-declaration) + - [Model composition in response](#model-composition-in-response) + - [Add a headers in response](#add-a-headers-in-response) + - [Use multiple path params](#use-multiple-path-params) + - [Add multiple paths](#add-multiple-paths) + - [Example value of struct](#example-value-of-struct) + - [SchemaExample of body](#schemaexample-of-body) + - [Description of struct](#description-of-struct) + - [Use swaggertype tag to supported custom type](#use-swaggertype-tag-to-supported-custom-type) + - [Use global overrides to support a custom type](#use-global-overrides-to-support-a-custom-type) + - [Use swaggerignore tag to exclude a field](#use-swaggerignore-tag-to-exclude-a-field) + - [Add extension info to struct field](#add-extension-info-to-struct-field) + - [Rename model to display](#rename-model-to-display) + - [How to use security annotations](#how-to-use-security-annotations) + - [Add a description for enum items](#add-a-description-for-enum-items) + - [Generate only specific docs file types](#generate-only-specific-docs-file-types) + - [Change the default Go Template action delimiters](#change-the-default-go-template-action-delimiters) + - [About the Project](#about-the-project) + - [Contributors](#contributors) + - [Backers](#backers) + - [Sponsors](#sponsors) + - [License](#license) + ## Getting started @@ -65,23 +81,24 @@ docker run --rm -v $(pwd):/code ghcr.io/swaggo/swag:latest Or download a pre-compiled binary from the [release page](https://github.com/swaggo/swag/releases). 3. Run `swag init` in the project's root folder which contains the `main.go` file. This will parse your comments and generate the required files (`docs` folder and `docs/docs.go`). + ```sh swag init ``` - Make sure to import the generated `docs/docs.go` so that your specific configuration gets `init`'ed. If your General API annotations do not live in `main.go`, you can let swag know with `-g` flag. - ```go - import _ "example-module-name/docs" - ``` - ```sh - swag init -g http/api.go - ``` +Make sure to import the generated `docs/docs.go` so that your specific configuration gets `init`'ed. If your General API annotations do not live in `main.go`, you can let swag know with `-g` flag. +```go +import _ "example-module-name/docs" +``` +```sh +swag init -g http/api.go +``` 4. (optional) Use `swag fmt` format the SWAG comment. (Please upgrade to the latest version) - ```sh - swag fmt - ``` +```sh +swag fmt +``` ## swag cli @@ -136,16 +153,16 @@ OPTIONS: ## Supported Web Frameworks -- [gin](http://github.com/swaggo/gin-swagger) -- [echo](http://github.com/swaggo/echo-swagger) -- [buffalo](https://github.com/swaggo/buffalo-swagger) -- [net/http](https://github.com/swaggo/http-swagger) -- [gorilla/mux](https://github.com/swaggo/http-swagger) -- [go-chi/chi](https://github.com/swaggo/http-swagger) -- [flamingo](https://github.com/i-love-flamingo/swagger) -- [fiber](https://github.com/gofiber/swagger) -- [atreugo](https://github.com/Nerzal/atreugo-swagger) -- [hertz](https://github.com/hertz-contrib/swagger) +- [gin](http://github.com/swaggo/gin-swagger) +- [echo](http://github.com/swaggo/echo-swagger) +- [buffalo](https://github.com/swaggo/buffalo-swagger) +- [net/http](https://github.com/swaggo/http-swagger) +- [gorilla/mux](https://github.com/swaggo/http-swagger) +- [go-chi/chi](https://github.com/swaggo/http-swagger) +- [flamingo](https://github.com/i-love-flamingo/swagger) +- [fiber](https://github.com/gofiber/swagger) +- [atreugo](https://github.com/Nerzal/atreugo-swagger) +- [hertz](https://github.com/hertz-contrib/swagger) ## How to use it with Gin @@ -153,6 +170,7 @@ Find the example source code [here](https://github.com/swaggo/swag/tree/master/e Finish the steps in [Getting started](#getting-started) 1. After using `swag init` to generate Swagger 2.0 docs, import the following packages: + ```go import "github.com/swaggo/gin-swagger" // gin-swagger middleware import "github.com/swaggo/files" // swagger embed files @@ -244,7 +262,7 @@ func main() { 3. Add [API Operation](#api-operation) annotations in `controller` code -``` go +```go package controller import ( @@ -322,17 +340,19 @@ The Swag Comments can be automatically formatted, just like 'go fmt'. Find the result of formatting [here](https://github.com/swaggo/swag/tree/master/example/celler). Usage: + ```shell swag fmt ``` Exclude folder： + ```shell swag fmt -d ./ --exclude ./internal ``` When using `swag fmt`, you need to ensure that you have a doc comment for the function to ensure correct formatting. -This is due to `swag fmt` indenting swag comments with tabs, which is only allowed *after* a standard doc comment. +This is due to `swag fmt` indenting swag comments with tabs, which is only allowed _after_ a standard doc comment. For example, use @@ -357,21 +377,21 @@ func (c *Controller) ListAccounts(ctx *gin.Context) { [Swagger 2.0 document](https://swagger.io/docs/specification/2-0/basic-structure/) -- [x] Basic Structure -- [x] API Host and Base Path -- [x] Paths and Operations -- [x] Describing Parameters -- [x] Describing Request Body -- [x] Describing Responses -- [x] MIME Types -- [x] Authentication - - [x] Basic Authentication - - [x] API Keys -- [x] Adding Examples -- [x] File Upload -- [x] Enums -- [x] Grouping Operations With Tags -- [ ] Swagger Extensions +- [x] Basic Structure +- [x] API Host and Base Path +- [x] Paths and Operations +- [x] Describing Parameters +- [x] Describing Request Body +- [x] Describing Responses +- [x] MIME Types +- [x] Authentication + - [x] Basic Authentication + - [x] API Keys +- [x] Adding Examples +- [x] File Upload +- [x] Enums +- [x] Grouping Operations With Tags +- [ ] Swagger Extensions # Declarative Comments Format @@ -380,71 +400,67 @@ func (c *Controller) ListAccounts(ctx *gin.Context) { **Example** [celler/main.go](https://github.com/swaggo/swag/blob/master/example/celler/main.go) -| annotation | description | example | -|-------------|--------------------------------------------|---------------------------------| -| title | **Required.** The title of the application.| // @title Swagger Example API | -| version | **Required.** Provides the version of the application API.| // @version 1.0 | -| description | A short description of the application. |// @description This is a sample server celler server. | -| tag.name | Name of a tag.| // @tag.name This is the name of the tag | -| tag.description | Description of the tag | // @tag.description Cool Description | -| tag.docs.url | Url of the external Documentation of the tag | // @tag.docs.url https://example.com| -| tag.docs.description | Description of the external Documentation of the tag| // @tag.docs.description Best example documentation | -| termsOfService | The Terms of Service for the API.| // @termsOfService http://swagger.io/terms/ | -| contact.name | The contact information for the exposed API.| // @contact.name API Support | -| contact.url | The URL pointing to the contact information. MUST be in the format of a URL. | // @contact.url http://www.swagger.io/support| -| contact.email| The email address of the contact person/organization. MUST be in the format of an email address.| // @contact.email support@swagger.io | -| license.name | **Required.** The license name used for the API.|// @license.name Apache 2.0| -| license.url | A URL to the license used for the API. MUST be in the format of a URL. | // @license.url http://www.apache.org/licenses/LICENSE-2.0.html | -| host | The host (name or ip) serving the API. | // @host localhost:8080 | -| BasePath | The base path on which the API is served. | // @BasePath /api/v1 | -| accept | A list of MIME types the APIs can consume. Note that Accept only affects operations with a request body, such as POST, PUT and PATCH. Value MUST be as described under [Mime Types](#mime-types). | // @accept json | -| produce | A list of MIME types the APIs can produce. Value MUST be as described under [Mime Types](#mime-types). | // @produce json | -| query.collection.format | The default collection(array) param format in query,enums:csv,multi,pipes,tsv,ssv. If not set, csv is the default.| // @query.collection.format multi -| schemes | The transfer protocol for the operation that separated by spaces. | // @schemes http https | -| externalDocs.description | Description of the external document. | // @externalDocs.description OpenAPI | -| externalDocs.url | URL of the external document. | // @externalDocs.url https://swagger.io/resources/open-api/ | -| x-name | The extension key, must be start by x- and take only json value | // @x-example-key {"key": "value"} | +| annotation | description | example | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| title | **Required.** The title of the application. | // @title Swagger Example API | +| version | **Required.** Provides the version of the application API. | // @version 1.0 | +| description | A short description of the application. | // @description This is a sample server celler server. | +| tag.name | Name of a tag. | // @tag.name This is the name of the tag | +| tag.description | Description of the tag | // @tag.description Cool Description | +| tag.docs.url | Url of the external Documentation of the tag | // @tag.docs.url https://example.com | +| tag.docs.description | Description of the external Documentation of the tag | // @tag.docs.description Best example documentation | +| termsOfService | The Terms of Service for the API. | // @termsOfService http://swagger.io/terms/ | +| contact.name | The contact information for the exposed API. | // @contact.name API Support | +| contact.url | The URL pointing to the contact information. MUST be in the format of a URL. | // @contact.url http://www.swagger.io/support | +| contact.email | The email address of the contact person/organization. MUST be in the format of an email address. | // @contact.email support@swagger.io | +| license.name | **Required.** The license name used for the API. | // @license.name Apache 2.0 | +| license.url | A URL to the license used for the API. MUST be in the format of a URL. | // @license.url http://www.apache.org/licenses/LICENSE-2.0.html | +| host | The host (name or ip) serving the API. | // @host localhost:8080 | +| BasePath | The base path on which the API is served. | // @BasePath /api/v1 | +| accept | A list of MIME types the APIs can consume. Note that Accept only affects operations with a request body, such as POST, PUT and PATCH. Value MUST be as described under [Mime Types](#mime-types). | // @accept json | +| produce | A list of MIME types the APIs can produce. Value MUST be as described under [Mime Types](#mime-types). | // @produce json | +| query.collection.format | The default collection(array) param format in query,enums:csv,multi,pipes,tsv,ssv. If not set, csv is the default. | // @query.collection.format multi | +| schemes | The transfer protocol for the operation that separated by spaces. | // @schemes http https | +| externalDocs.description | Description of the external document. | // @externalDocs.description OpenAPI | +| externalDocs.url | URL of the external document. | // @externalDocs.url https://swagger.io/resources/open-api/ | +| x-name | The extension key, must be start by x- and take only json value | // @x-example-key {"key": "value"} | ### Using markdown descriptions -When a short string in your documentation is insufficient, or you need images, code examples and things like that you may want to use markdown descriptions. In order to use markdown descriptions use the following annotations. +When a short string in your documentation is insufficient, or you need images, code examples and things like that you may want to use markdown descriptions. In order to use markdown descriptions use the following annotations. -| annotation | description | example | -|-------------|--------------------------------------------|---------------------------------| -| title | **Required.** The title of the application.| // @title Swagger Example API | -| version | **Required.** Provides the version of the application API.| // @version 1.0 | -| description.markdown | A short description of the application. Parsed from the api.md file. This is an alternative to @description |// @description.markdown No value needed, this parses the description from api.md | -| tag.name | Name of a tag.| // @tag.name This is the name of the tag | -| tag.description.markdown | Description of the tag this is an alternative to tag.description. The description will be read from a file named like tagname.md | // @tag.description.markdown | - +| annotation | description | example | +| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| title | **Required.** The title of the application. | // @title Swagger Example API | +| version | **Required.** Provides the version of the application API. | // @version 1.0 | +| description.markdown | A short description of the application. Parsed from the api.md file. This is an alternative to @description | // @description.markdown No value needed, this parses the description from api.md | +| tag.name | Name of a tag. | // @tag.name This is the name of the tag | +| tag.description.markdown | Description of the tag this is an alternative to tag.description. The description will be read from a file named like tagname.md. You need to include the `--markdownFiles ` flag pointing to the directory containing the markdown files to be able to use this feature. | // @tag.description.markdown | ## API Operation **Example** [celler/controller](https://github.com/swaggo/swag/tree/master/example/celler/controller) - -| annotation | description | -|-------------|----------------------------------------------------------------------------------------------------------------------------| -| description | A verbose explanation of the operation behavior. | -| description.markdown | A short description of the application. The description will be read from a file. E.g. `@description.markdown details` will load `details.md`| // @description.file endpoint.description.markdown | -| id | A unique string used to identify the operation. Must be unique among all API operations. | -| tags | A list of tags to each API operation that separated by commas. | -| summary | A short summary of what the operation does. | -| accept | A list of MIME types the APIs can consume. Note that Accept only affects operations with a request body, such as POST, PUT and PATCH. Value MUST be as described under [Mime Types](#mime-types). | -| produce | A list of MIME types the APIs can produce. Value MUST be as described under [Mime Types](#mime-types). | -| param | Parameters that separated by spaces. `param name`,`param type`,`data type`,`is mandatory?`,`comment` `attribute(optional)` | -| security | [Security](#security) to each API operation. | -| success | Success response that separated by spaces. `return code or default`,`{param type}`,`data type`,`comment` | -| failure | Failure response that separated by spaces. `return code or default`,`{param type}`,`data type`,`comment` | -| response | As same as `success` and `failure` | -| header | Header in response that separated by spaces. `return code`,`{param type}`,`data type`,`comment` | -| router | Path definition that separated by spaces. `path`,`[httpMethod]` | -| x-name | The extension key, must be start by x- and take only json value. | -| x-codeSample | Optional Markdown usage. take `file` as parameter. This will then search for a file named like the summary in the given folder. | -| deprecated | Mark endpoint as deprecated. | - - +| annotation | description | +| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | +| description | A verbose explanation of the operation behavior. | +| description.markdown | A short description of the application. The description will be read from a file. E.g. `@description.markdown details` will load `details.md` | // @description.file endpoint.description.markdown | +| id | A unique string used to identify the operation. Must be unique among all API operations. | +| tags | A list of tags to each API operation that separated by commas. | +| summary | A short summary of what the operation does. | +| accept | A list of MIME types the APIs can consume. Note that Accept only affects operations with a request body, such as POST, PUT and PATCH. Value MUST be as described under [Mime Types](#mime-types). | +| produce | A list of MIME types the APIs can produce. Value MUST be as described under [Mime Types](#mime-types). | +| param | Parameters that separated by spaces. `param name`,`param type`,`data type`,`is mandatory?`,`comment` `attribute(optional)` | +| security | [Security](#security) to each API operation. | +| success | Success response that separated by spaces. `return code or default`,`{param type}`,`data type`,`comment` | +| failure | Failure response that separated by spaces. `return code or default`,`{param type}`,`data type`,`comment` | +| response | As same as `success` and `failure` | +| header | Header in response that separated by spaces. `return code`,`{param type}`,`data type`,`comment` | +| router | Path definition that separated by spaces. `path`,`[httpMethod]` | +| x-name | The extension key, must be start by x- and take only json value. | +| x-codeSample | Optional Markdown usage. take `file` as parameter. This will then search for a file named like the summary in the given folder. | +| deprecated | Mark endpoint as deprecated. | ## Mime Types @@ -452,7 +468,7 @@ When a short string in your documentation is insufficient, or you need images, c Besides that, `swag` also accepts aliases for some MIME Types as follows: | Alias | MIME Type | -|-----------------------|-----------------------------------| +| --------------------- | --------------------------------- | | json | application/json | | xml | text/xml | | plain | text/plain | @@ -466,44 +482,42 @@ Besides that, `swag` also accepts aliases for some MIME Types as follows: | jpeg | image/jpeg | | gif | image/gif | - - ## Param Type -- query -- path -- header -- body -- formData +- query +- path +- header +- body +- formData ## Data Type -- string (string) -- integer (int, uint, uint32, uint64) -- number (float32) -- boolean (bool) -- file (param data type when uploading) -- user defined struct +- string (string) +- integer (int, uint, uint32, uint64) +- number (float32) +- boolean (bool) +- file (param data type when uploading) +- user defined struct ## Security -| annotation | description | parameters | example | -|------------|-------------|------------|---------| -| securitydefinitions.basic | [Basic](https://swagger.io/docs/specification/2-0/authentication/basic-authentication/) auth. | | // @securityDefinitions.basic BasicAuth | -| securitydefinitions.apikey | [API key](https://swagger.io/docs/specification/2-0/authentication/api-keys/) auth. | in, name, description | // @securityDefinitions.apikey ApiKeyAuth | -| securitydefinitions.oauth2.application | [OAuth2 application](https://swagger.io/docs/specification/authentication/oauth2/) auth. | tokenUrl, scope, description | // @securitydefinitions.oauth2.application OAuth2Application | -| securitydefinitions.oauth2.implicit | [OAuth2 implicit](https://swagger.io/docs/specification/authentication/oauth2/) auth. | authorizationUrl, scope, description | // @securitydefinitions.oauth2.implicit OAuth2Implicit | -| securitydefinitions.oauth2.password | [OAuth2 password](https://swagger.io/docs/specification/authentication/oauth2/) auth. | tokenUrl, scope, description | // @securitydefinitions.oauth2.password OAuth2Password | -| securitydefinitions.oauth2.accessCode | [OAuth2 access code](https://swagger.io/docs/specification/authentication/oauth2/) auth. | tokenUrl, authorizationUrl, scope, description | // @securitydefinitions.oauth2.accessCode OAuth2AccessCode | - - -| parameters annotation | example | -|---------------------------------|-------------------------------------------------------------------------| -| in | // @in header | -| name | // @name Authorization | -| tokenUrl | // @tokenUrl https://example.com/oauth/token | -| authorizationurl | // @authorizationurl https://example.com/oauth/authorize | -| scope.hoge | // @scope.write Grants write access | -| description | // @description OAuth protects our entity endpoints | + +| annotation | description | parameters | example | +| -------------------------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------ | +| securitydefinitions.basic | [Basic](https://swagger.io/docs/specification/2-0/authentication/basic-authentication/) auth. | | // @securityDefinitions.basic BasicAuth | +| securitydefinitions.apikey | [API key](https://swagger.io/docs/specification/2-0/authentication/api-keys/) auth. | in, name, description | // @securityDefinitions.apikey ApiKeyAuth | +| securitydefinitions.oauth2.application | [OAuth2 application](https://swagger.io/docs/specification/authentication/oauth2/) auth. | tokenUrl, scope, description | // @securitydefinitions.oauth2.application OAuth2Application | +| securitydefinitions.oauth2.implicit | [OAuth2 implicit](https://swagger.io/docs/specification/authentication/oauth2/) auth. | authorizationUrl, scope, description | // @securitydefinitions.oauth2.implicit OAuth2Implicit | +| securitydefinitions.oauth2.password | [OAuth2 password](https://swagger.io/docs/specification/authentication/oauth2/) auth. | tokenUrl, scope, description | // @securitydefinitions.oauth2.password OAuth2Password | +| securitydefinitions.oauth2.accessCode | [OAuth2 access code](https://swagger.io/docs/specification/authentication/oauth2/) auth. | tokenUrl, authorizationUrl, scope, description | // @securitydefinitions.oauth2.accessCode OAuth2AccessCode | + +| parameters annotation | example | +| --------------------- | -------------------------------------------------------- | +| in | // @in header | +| name | // @name Authorization | +| tokenUrl | // @tokenUrl https://example.com/oauth/token | +| authorizationurl | // @authorizationurl https://example.com/oauth/authorize | +| scope.hoge | // @scope.write Grants write access | +| description | // @description OAuth protects our entity endpoints | ## Attribute @@ -531,29 +545,29 @@ type Foo struct { ### Available -Field Name | Type | Description ----|:---:|--- -validate | `string` | Determines the validation for the parameter. Possible values are: `required,optional`. -default | * | Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "default" has no meaning for required parameters.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined [`type`](#parameterType) for this parameter. -maximum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. -minimum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. -multipleOf | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1. -maxLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1. -minLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2. -enums | [\*] | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1. -format | `string` | The extending format for the previously mentioned [`type`](#parameterType). See [Data Type Formats](https://swagger.io/specification/v2/#dataTypeFormat) for further details. -collectionFormat | `string` |Determines the format of the array if type array is used. Possible values are: Default value is `csv`. -example | * | Declares the example for the parameter value -extensions | `string` | Add extension to parameters. +| Field Name | Type | Description | +| -------------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| validate | `string` | Determines the validation for the parameter. Possible values are: `required,optional`. | +| default | \* | Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "default" has no meaning for required parameters.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined [`type`](#parameterType) for this parameter. | +| maximum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. | +| minimum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. | +| multipleOf | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1. | +| maxLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1. | +| minLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2. | +| enums | [\*] | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1. | +| format | `string` | The extending format for the previously mentioned [`type`](#parameterType). See [Data Type Formats](https://swagger.io/specification/v2/#dataTypeFormat) for further details. | +| collectionFormat | `string` | Determines the format of the array if type array is used. Possible values are: Default value is `csv`. | +| example | \* | Declares the example for the parameter value | +| extensions | `string` | Add extension to parameters. | ### Future -Field Name | Type | Description ----|:---:|--- -pattern | `string` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. -maxItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2. -minItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3. -uniqueItems | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4. +| Field Name | Type | Description | +| ---------------------------------------------- | :-------: | ---------------------------------------------------------------------------------- | +| pattern | `string` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. | +| maxItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2. | +| minItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3. | +| uniqueItems | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4. | ## Examples @@ -582,7 +596,6 @@ type Account struct { } ``` - ### Function scoped struct declaration You can declare your request response structs inside a function body. @@ -605,8 +618,8 @@ func MyHandler() { } ``` - ### Model composition in response + ```go // JSONResult's data field will be overridden by the specific type proto.Order @success 200 {object} jsonresult.JSONResult{data=proto.Order} "desc" @@ -625,24 +638,29 @@ type Order struct { //in `proto` package } ``` -- also support array of objects and primitive types as nested response +- also support array of objects and primitive types as nested response + ```go @success 200 {object} jsonresult.JSONResult{data=[]proto.Order} "desc" @success 200 {object} jsonresult.JSONResult{data=string} "desc" @success 200 {object} jsonresult.JSONResult{data=[]string} "desc" ``` -- overriding multiple fields. field will be added if not exists +- overriding multiple fields. field will be added if not exists + ```go @success 200 {object} jsonresult.JSONResult{data1=string,data2=[]string,data3=proto.Order,data4=[]proto.Order} "desc" ``` -- overriding deep-level fields + +- overriding deep-level fields + ```go type DeepObject struct { //in `proto` package ... } @success 200 {object} jsonresult.JSONResult{data1=proto.Order{data=proto.DeepObject},data2=[]proto.Order{data=[]proto.DeepObject}} "desc" ``` + ### Add a headers in response ```go @@ -708,6 +726,7 @@ type Account struct { But it writes all struct field comments as is. So, generated swagger doc as follows: + ```json "Account": { "type":"object", @@ -726,6 +745,7 @@ So, generated swagger doc as follows: ``` ### Use swaggertype tag to supported custom type + [#201](https://github.com/swaggo/swag/issues/201#issuecomment-475479409) ```go @@ -763,13 +783,16 @@ type Account struct { ``` [#379](https://github.com/swaggo/swag/issues/379) + ```go type CerticateKeyPair struct { Crt []byte `json:"crt" swaggertype:"string" format:"base64" example:"U3dhZ2dlciByb2Nrcw=="` Key []byte `json:"key" swaggertype:"string" format:"base64" example:"U3dhZ2dlciByb2Nrcw=="` } ``` + generated swagger doc as follows: + ```go "api.MyBinding": { "type":"object", @@ -796,6 +819,7 @@ If you are using generated files, the [`swaggertype`](#use-swaggertype-tag-to-su By passing a mapping to swag with `--overridesFile` you can tell swag to use one type in place of another wherever it appears. By default, if a `.swaggo` file is present in the current directory it will be used. Go code: + ```go type MyStruct struct { ID sql.NullInt64 `json:"id"` @@ -804,6 +828,7 @@ type MyStruct struct { ``` `.swaggo`: + ``` // Replace all NullInt64 with int replace database/sql.NullInt64 int @@ -817,13 +842,13 @@ Possible directives are comments (beginning with `//`), `replace path/to/a.type (Note that the full paths to any named types must be provided to prevent problems when multiple packages define a type with the same name) Rendered: + ```go "types.MyStruct": { "id": "integer" } ``` - ### Use swaggerignore tag to exclude a field ```go @@ -857,6 +882,7 @@ generate swagger doc as follows: } } ``` + ### Rename model to display ```golang @@ -898,7 +924,6 @@ Make it OR condition // @Security OAuth2Application[write, admin] || APIKeyAuth ``` - ### Add a description for enum items ```go @@ -913,9 +938,10 @@ type Example struct { ### Generate only specific docs file types By default `swag` command generates Swagger specification in three different files/file types: -- docs.go -- swagger.json -- swagger.yaml + +- docs.go +- swagger.json +- swagger.yaml If you would like to limit a set of file types which should be generated you can use `--outputTypes` (short `-ot`) flag. Default value is `go,json,yaml` - output types separated with comma. To limit output only to `go` and `yaml` files, you would write `go,yaml`. With complete command that would be `swag init --outputTypes go,yaml`. @@ -933,32 +959,35 @@ See [this file](https://github.com/swaggo/swag/blob/master/testdata/generics_nes and other examples. ### Change the default Go Template action delimiters + [#980](https://github.com/swaggo/swag/issues/980) [#1177](https://github.com/swaggo/swag/issues/1177) If your swagger annotations or struct fields contain "{{" or "}}", the template generation will most likely fail, as these are the default delimiters for [go templates](https://pkg.go.dev/text/template#Template.Delims). To make the generation work properly, you can change the default delimiters with `-td`. For example: + ```console swag init -g http/api.go -td "[[,]]" ``` + The new delimiter is a string with the format "``,``". ## About the Project + This project was inspired by [yvasiyarov/swagger](https://github.com/yvasiyarov/swagger) but we simplified the usage and added support a variety of [web frameworks](#supported-web-frameworks). Gopher image source is [tenntenn/gopher-stickers](https://github.com/tenntenn/gopher-stickers). It has licenses [creative commons licensing](http://creativecommons.org/licenses/by/3.0/deed.en). + ## Contributors This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. - ## Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/swag#backer)] - ## Sponsors Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/swag#sponsor)] @@ -974,8 +1003,6 @@ Support this project by becoming a sponsor. Your logo will show up here with a l - - - ## License + [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fswaggo%2Fswag.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fswaggo%2Fswag?ref=badge_large)