java api 문서1

• 

  [Spring] Spring REST Docs 활용하여 API 문서 만들기 안녕하세요 깐지와꾼지파파 입니다 !!! 그동안 글을 너~~~무 쓰지 않아.. 오랜만에 작성하네요..^^ 오늘은 api 문서를 어떻게 아름답게 공유하면 좋을까 고민하다가 restdocs 를 발견하게 관련하여 글을 써 보려고 합니다. 작성에 앞서 자바 api 문서 자동화 라이브러리로는 주로 두가지를 많이 사용하는데요 Swagger, Spring Rest Docs 두 가지가 대표적입니다 ! 1. 고민해야 할 이슈 1. RESTful 서비스에 대해 정확하고 읽기 쉬운 문서 생성 및 제공 2. 클라이언트 작업자와 서버 작업자 사이의 API 문서 버전 동기화 3. 테스트를 통하여 API 문서 자동 생성 2. Rest Docs 을 선택한 이유 1. 테스트를 성공해야만 문서가 만들어 진다. 2. 소스 자체에 영향이 없.. 백앤드 이야기/JAVA&Spring 2021. 6. 30.