OpenAPI Spec 의 최종 버전은 3.1 이며
...
data type은 format modifier 속성을 가질 수 있습니다.
| type | format | Comments |
|---|
| integer | int32 | signed 32 bits |
| integer | int64 | signed 64 bits (a.k.a long) |
| number | float |
|
| number | double |
|
| string | password | A hint to UIs to obscure input. |
Schema
스키마중에 많이 사용하는 Object 만 추렸습니다.
...
OpenAPI-Specification/3.1.0.md at main · OAI/OpenAPI-Specification (github.com)
| name | type | Description |
|---|
| title | string | REQUIRED. The title of the API. |
| version | string | REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). |
| summary | string | A short summary of the API. |
| description | string | A description of the API. CommonMark syntax MAY be used for rich text representation. |
Operation Object
OpenAPI-Specification/3.1.0.md at main · OAI/OpenAPI-Specification (github.com)
| Field Name | type | Description |
|---|
| tags | [string] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. |
| summary | string | A short summary of the API. |
| description | string | A description of the API. CommonMark syntax MAY be used for rich text representation. |
| operationId | string | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. |
|
|
|
SecurityScheme
OpenAPI-Specification/3.1.0.md at main · OAI/OpenAPI-Specification (github.com)
| Widget Connector |
|---|
| url | https://carbon.now.sh/?bg=rgba%28171%2C+184%2C+195%2C+1%29&t=material&wt=none&l=auto&ds=true&dsyoff=20px&dsblur=68px&wc=true&wa=true&pv=56px&ph=56px&ln=true&fl=1&fm=Hack&fs=14px&lh=133%25&si=false&es=2x&wm=false&code=%253C%253Fphp%250A%250A%252F**%250A%2520*%2520%2540OA%255CSecurityScheme%28%250A%2520*%2520%2520%2520%2520%2520type%253D%2522oauth2%2522%252C%250A%2520*%2520%2520%2520%2520%2520name%253D%2522petstore_auth%2522%252C%250A%2520*%2520%2520%2520%2520%2520securityScheme%253D%2522petstore_auth%2522%252C%250A%2520*%2520%2520%2520%2520%2520%2540OA%255CFlow%28%250A%2520*%2520%2520%2520%2520%2520%2520%2520%2520%2520flow%253D%2522implicit%2522%252C%250A%2520*%2520%2520%2520%2520%2520%2520%2520%2520%2520authorizationUrl%253D%2522http%253A%252F%252Fpetstore.swagger.io%252Foauth%252Fdialog%2522%252C%250A%2520*%2520%2520%2520%2520%2520%2520%2520%2520%2520scopes%253D%257B%250A%2520*%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2522write%253Apets%2522%253A%2520%2522modify%2520pets%2520in%2520your%2520account%2522%252C%250A%2520*%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2522read%253Apets%2522%253A%2520%2522read%2520your%2520pets%2522%252C%250A%2520*%2520%2520%2520%2520%2520%2520%2520%2520%2520%257D%250A%2520*%2520%2520%2520%2520%2520%29%250A%2520*%2520%29%250A%2520*%2520%2540OA%255CSecurityScheme%28%250A%2520*%2520%2520%2520%2520%2520type%253D%2522apiKey%2522%252C%250A%2520*%2520%2520%2520%2520%2520in%253D%2522header%2522%252C%250A%2520*%2520%2520%2520%2520%2520securityScheme%253D%2522api_key%2522%252C%250A%2520*%2520%2520%2520%2520%2520name%253D%2522api_key%2522%250A%2520*%2520%29%250A%2520*%252F |
|---|
|
Ref
