일 | 월 | 화 | 수 | 목 | 금 | 토 |
---|---|---|---|---|---|---|
1 | ||||||
2 | 3 | 4 | 5 | 6 | 7 | 8 |
9 | 10 | 11 | 12 | 13 | 14 | 15 |
16 | 17 | 18 | 19 | 20 | 21 | 22 |
23 | 24 | 25 | 26 | 27 | 28 |
Tags
- 프로그래머스
- REDIS
- AWS
- JPA
- 코드리뷰
- yml
- 서블릿
- Docker
- 자바
- AOP
- 트랜잭션
- 우아한세미나
- 미션
- Paging
- MSA
- mock
- 의존성
- 스프링부트
- 레벨2
- 세션
- HTTP
- 스프링 부트
- Spring Batch
- 백준
- JUnit5
- 우아한테크코스
- Level2
- 프리코스
- 우테코
- CircuitBreaker
Archives
- Today
- Total
목록api문서화 (1)
늘
[RestDocs]API 문서화
Spring REST Docs는 테스트가 통과해야 문서화가 된다. API문서 자동화에는 대표적으로 swagger와 Rest docs가 있는데 개인적으로 RestDocs를 선호한다. 장점 Spring REST Docs는 테스트가 성공하지 않으면 문서를 만들 수 없습니다. 즉, 반 강제로 테스트를 해야 하고 이를 통해 신뢰도 높은 api문서가 나온다. 실제 코드에 추가되는 코드가 없습니다. - swagger를 보면 프로덕션 코드에 어노테이션이 덕지덕지 붙어있는데, 이는 관심사의 분리가 실패된 케이스가 아닌가.. 라는 생각이 들어서 RestDocs를 선호한다. 커스터마이징 가능 문서화에 사용할 테스트 도구 여기서 API문서화 할때는 Controller테스트를 통해서 생성하므로 RestAssured보다는 Moc..
백앤드 개발일지/스프링부트
2022. 6. 3. 20:20