[TIL] 코드스테이츠 SEB BE Day 56
in TIL
💡 Today I Will Learn
- API 문서화
- Spring RestDocs
✏️ Check Box
📌 정리
API 명세를 작성하는 방법들에 대해 학습하였다. 현재 진행중인 프로젝트에서는 PostMan으로 프론트 멤버들과 API를 공유하고 있었는데, API가 늘어나면서 헷갈리고 복잡하기도 해서 방법을 찾고 있긴 하였다.
API 문서화 툴에는 Swagger를 많이 들어보긴 했는데, 어노테이션이 이것저것 많이 붙어서 Controller가 더러워진다는 단점이 있다고 한다. 그래서 Spring RestDocs를 배우고 있다. 또다른 장점은 Slice Test를 기반으로 하여 테스트가 성공하였을 때 문서를 작성해준다는 것이다. 참으로 적절한 라이브러리가 아닐 수 없다😁
🎯 Next Week
- AsciiDoc
- API 문서화 실습
Back to [TIL] 코드스테이츠 SEB BE Day 55
