[Spring] API 문서화(apidoc, swagger) 라이브러리 비교 - springfox vs springdoc-openapi

api 문서화(apidoc) 라이브러리 springfox과 springdoc-openapi를 비교해보려고 한다.

 

api 문서화(apidoc) 라이브러리란?

 

말 그대로 api를 보기쉽게 문서화할 때 사용하는 라이브러리다.

 

스웨거(Swagger)라고 많이 들어봤을 거다.

 

단순 문서화만 해주는 게 아니라 실제 요청 값을 세팅해서 요청하고 응답 값을 받을 수 있다.

 

springfox vs springdoc-openapi

 

정답은 springdoc-openapi다.

 

왜 springdoc-openapi가 더 좋을까?

 

1. springfox는 더 이상 업데이트를 하지 않는다.

 

2020년 7월 14일을 마지막 릴리즈로 업데이트가 없다.

 

springfox가 인기가 많긴 했지만 써보면 이것저것 지원이 안 되는 게 많다.

 

관련 레퍼런스를 찾아봐도 답을 찾기가 어렵다. 답답해 죽겠다.

 

 

이에 비해, springdoc-openapi는 17일 전에도 버전 업데이트를 했다.

 

활발하게 소통 중이고 계속 발전하고 있다.

 

이것만으로도 springdoc-openapi를 써야 할 이유가 충분하다.

 

 

2. springdoc-openapi는 openAPI3를 지원한다. 잘!

 

springfox도 openAPI3를 지원하긴 한다.

 

근데 설정하다보면 뭔가 답답하고 불편하다.

 

써보면 알 수 있는데 springdoc-openapi는 정말 셋팅이 간단하다.

 

혹시라도 지금 springfox를 쓰고 있다면?

 

당장 springdoc-openapi로 변경하자.

 

 springdoc-openapi로 변경을 하는 방법은 아주 간단하다.

 

얘네도 springfox에서 많이 넘어온다는 걸 아는지 공식 문서에서 변경하는 방법을 알려주고 있다.

 

OpenAPI 3 Library for spring-boot

 

springdoc-openapi 사용법

 

공식 문서에 사용법이 아주 잘 나와있다.

 

OpenAPI 3 Library for spring-boot

 

apidoc 검색해서 나온 게 springfox였어서 처음에 그걸로 개발한 게 답답해서 써봤다.

 

springdoc-openapi 관련 글을 먼저 봤다면 정말 좋았을텐데 ㅠㅠ.. 나와 같은 실수를 하지 않기를 바라며 이 글을 써봅니다.