OpenAPI Specification

OpenAPI Specification 이란

OAS는 REST API의 표준 인터페이스를 설명한다.

이를 통해, 직접 소스코드를 보거나 추가 문서 필요없이 서비스를 이해할 수 있다.

OpenAPI 3.0

OpenAPI 3.0버전은 잡다한 것을 빼고 간결해졌다.

작성법

YAML을 이용하거나 json파일을 이용하여 OpenAPI Spec 규격으로 작성한다.

이를 이용하여 Swagger UI 같은걸 통해 Interactive한 문서를 작성 할 수도 있다.

reference: 링크

cf) OpenAPI 문서 나누는법

reference : 링크