Open API Spec
OpenAPI Specification (OAS)는 RESTful API를 기술하는 표준으로 서비스에서 제공하는 API의 기능과 End Point를 개발자나 시스템이 자동으로 발견하고 처리하는데 필요한 정보를 제공한다.
OAS는 JSON이나 yml 형식으로 기술해야 하며 OAS파일을 읽어서 디플로이 해주는 도구(swagger-ui)를 사용하면 브라우저에서 편하게 API 문서를 볼 수 있다.
OAS는 이전에 Swagger spec으로 불렸으며 3.0버전 부터 OpenAPI 3.0 Sepcification 이라는 이름으로 표준화 되었다.
Swagger
Swagger는 OpenAPI Spec에 맞게 디자인, 문서화하고 빌드하기 위한 도구들의 모음으로 다음과 같은 요소들이 있다.
- Swagger Editor : 브라우저 기반의 편집기로 OpenAPI spec을 쉽게 작성할 수 있도록 도와준다.
- Swagger UI : OpenAPI spec 문서를 디플로이하고 브라우저에서 보기좋게 표시할 수 있도록 해준다. swagger-ui 대신 redoc을 사용해도 된다.
- Swagger Codegen : OpenAPI spec에 맞게 Server나 Client의 stub code를 생성해준다. 개발자는 생성된 코드의 비즈니스 로직에 집중해 구현하면 된다.
참고서적
https://etloveguitar.tistory.com/58
https://www.lesstif.com/software-engineering/openapi-swagger-redoc-106857823.html
