728x90
REST DOCS 문서 작성을 위한 스터디
- API문서 자동화를 위한 Rest Docs사용하는 이유?
- Spring 응용 프로그램의 RESTful API를 문서화하는데 사용할 수 있는 도구이다.
- 코드베이스와 항상 동기화되는 정확한 최신 문서를 작성하여 문서가 최신이 아니거나 부정확해질 가능성을 줄일 수 있다.
- API문서가 API의 실제 동작과 일치하도록 할 수 있어 개발자에게 혼동과 오해를 방지할 수 있다.
- Spring Rest Docs문서 적용하기
- 프로젝트의 빌드 파일(build.gradle)에 필요한 종속성을 추가한다.
- Spring MVC Test, WebTest Client를 사용하여 API에 대한 테스트 사례를 작성한다.
- @AutoConfigureRestDocs, @RunWith(SpringRunner.class) 및 @Test와 같은 SpringRestDocs 어노테이션을 추가한다.
- Spring Rest Docs를 사용하여 API를 생성한다
- Gradle 적용
'WorkHard > Project' 카테고리의 다른 글
| [Project] 솔로프로젝트 - Kakao 로그인(1) (0) | 2023.04.18 |
|---|---|
| [Project] 솔로프로젝트 - Comment코드 작성 (0) | 2023.04.09 |
| [Project] 메인프로젝트 'Why Stay?' Refactoring (0) | 2023.04.04 |
| [Project] 솔로프로젝트 - Member코드 작성 (0) | 2023.03.29 |
| [Project] 솔로프로젝트 - 게시판 만들기(API 설계) (0) | 2023.03.28 |