Fast API 는 더 깔끔한 API UI도 제공합니다 ( ReDoc )

보통 FastAPI 를 시작하지 얼마 안된 개발자들은 API UI 문서로 OpenAPI기반인 Swagger 를 많이 사용하는데, 사실 나는 Swagger 이 문서로서의 가독성이 좋은지도 모르겠고 무엇보다 그닥 디자인상 마음에 들지 않는다. 다만 API를 테스트해보는 기능이 있기 때문에 많이 사용할 뿐이다. 

 

좀 더 깔끔한 UI로 API 문서를 제공하고 싶은 경우에는 ReDoc 이라는 옵션도 생각해 볼 수 있는데, 이것도 FastAPI에서 디폴트로 제공하고 있다. 다만 ReDoc 은 API를 테스트 해볼 수 있는 기능은 없어서 문서 용도로만 제공하는게 좋겠다.

 

localhost:8000 에 FastAPI 서버를 띄웠다고 가정하겠다.

 

1. Swagger

URL: localhost:8000/docs

 

 

2. ReDoc

URL: localhost:8000/redoc

 

 

Tip

혹시 협업하는 업체나 개발자가 있는데, 보안상의 이유로 본인의 API 서버 URL에 협업자가 접근할 수 없다면 openapi.json 파일을 Swagger 나 ReDoc 에서 다운받아서 협업자에게 전달해주면 된다. 역시 openapi.json 파일만으로는 API 테스트는 해볼 수 없지만 ReDoc 과 같이 상대방도 이쁘게 API 명세서를 볼 수 있다. 다운받는 방법은 다음과 같다. 

Swagger 에서 다운로드

ReDoc 에서 다운로드