2021년 08월 15일 TIL

오늘은 Spring Rest Docs로 프로젝트 API 명세서를 만들었다.

https://i5b305.p.ssafy.io/api/docs/api-doc.html

배포된 API 명세서이다! 주로 많이 참조한 내용은

https://techblog.woowahan.com/2678/

우아한 형제들의 기술 블로그를 참조하여 만들었다.

깃헙도 참조하여 성능 향상까지 최대한 따라해보려고 노력했는데, 실제 프로젝트에 도입하려는 것이다보니 여건상 어려운 부분이 많았다.

그래도 Common Response를 위해 별도의 Controller를 Test에 만들어서 수행하는 등의 리팩토링을 수행했다.

html 문서로 만들 때 목차가 만들어지지 않는 이슈가 존재했지만, 인텔리제이 내부에서 직접 html을 만들어서 옮기면 해결되었다. 정확한 원인을 찾기 위해 계속 문서를 읽어보는 중이다.