API document

Swagger

Swagger는 2011년에 처음 릴리즈된 …​ 아마 대부분 알고 있는 것이 Swagger UI일거라 생각한다.

Swagger UI

Swagger에서 만든 오픈 소스중 하나로, OpenAPI(이전의 Swagger) Specification을 시각화해준다.

References

OpenAPI

Swagger Specification 이었던 OpenAPI Specification(OAS)는 RESTful한 웹 서비스를 기계가 읽을 수 있는machine-readable 인터페이스 파일에 대한 명세서다. 원래 Swagger 프레임워크의 일부였던 이 프로젝트는 2016년 Linux Foundation의 오픈 소스 협업 프로젝트인 OpenAPI Initiative가 감독하는 별도의 프로젝트가 되었다. Swagger 혹은 여러 툴들은 이 인터페이스 파일을 통해 코드, 문서, 테스트 케이스를 생성할 수 있다.

References

Springfox

  • 스프링 프레임워크에서 Swagger를 이용해 API 문서를 쉽게 만들어주는 라이브러리

Springdoc

  • 2018년부터 Springfox 업데이트가 없었고, OAS를 지원하는 최신 라이브러리가 없었다. 이 때(2019년), OAS를 지원하는 라이브러리가 새로 나왔는데, 이것이 Springdoc이다.

  • 2017년 7월, OAS 3가 릴리즈되었다. 이 때, Springfox는 이를 지원하지 않았고 Springdoc는 지원했다.

  • 2020년 6월, Springfox는 2.10.0을 릴리즈했다.

References

References