Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


OpenAPI Spec 의 최종 버전은 3.1 이며 

...

data type은 format modifier 속성을 가질 수 있습니다.

typeformatComments
integerint32signed 32 bits
integerint64signed 64 bits (a.k.a long)
numberfloat
numberdouble
stringpasswordA hint to UIs to obscure input.


Schema

스키마중에 많이 사용하는 Object 만 추렸습니다.

...

OpenAPI-Specification/3.1.0.md at main · OAI/OpenAPI-Specification (github.com)


nametypeDescription
titlestringREQUIRED. The title of the API.
versionstringREQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
summarystringA short summary of the API.
descriptionstringA 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 NametypeDescription
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.
summarystringA short summary of the API.
descriptionstringA description of the API. CommonMark syntax MAY be used for rich text representation.
operationIdstringUnique 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)





Ref