💡 노션
장점
- 비교적 간편하게 문서를 작성할 수 있다.
- 코드상의 추가되는것이 없어 코드의 가독성을 해치지않는다.
단점
- 자동화가 되지않아 사람이 수정하는걸 놓치면 실제 API 스펙과 달라진다.
💡 Spring Doc + Swagger
장점
- 자동화로 문서와 코드의 일치를 유지할 수 있다.
단점
- 프로덕션 코드에 문서화에 대한 코드가 포함되므로 가독성이 떨어진다.
- API 스펙이 변경되어도 어노테이션을 변경하지않으면 문서와 일치시킬 수 없다.
💡 Spring REST Docs (테스트기반)
장점
- 테스트코드의 성공여부에 따라 문서가 생성되므로 API 스펙과 항상 일치함을 보장할 수 있다.
단점
- 문서화를 위한 테스트코드를 작성해야한다.
우엉이의 코딩 성장일기💻