serverless-node-swag

为serverless的node云函数的注释生成符合swagger2规范的json

API Operation

| annotation | description | | ----------- | ----------- | description | A verbose explanation of the operation |behavior. 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. produce | A list of MIME types the APIs can produce. Value MUST be as described under Mime Types. param | Parameters that separated by spaces. param name,param type,data type,is mandatory?,comment attribute(optional) 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 Type

swag accepts all MIME Types which are in the correct format, that is, match /. Besides that, swag also accepts aliases for some MIME Types as follows:

| Alias | MIME Type | | ----- | --------- | | json | application/json| xml |text/xml plain | text/plain html | text/html mpfd | multipart/form-data x-www-form-urlencoded | application/x-www-form-urlencoded | json-api| application/vnd.api+json json-stream | application/x-json-stream octet-stream | application/octet-stream png | image/png jpeg | image/jpeg gif | image/gif

Data Type

• string
• number
• boolean
• array
• object

Param Type

• query
• path
• header
• body
• formData