Table of Contents |
---|
...
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)