Skip to content

[BE] API 문서화

xrabcde edited this page Aug 1, 2021 · 1 revision
  • test를 기반으로 작성되기 때문에 인수테스트에 반드시 해당 api 성공 사례가 있어야 합니다.

  • test 메서드에 아래 메서드들을 추가합니다.

.given(DocumentUtils.getRequestSpecification())
.accept("application/json")
.filter(document("기능명/get", DocumentUtils.getRequestPreprocessor(), DocumentUtils.getResponsePreprocessor())) 
//기능명에 도메인명 작성하고 그 뒤에 메서드명을 적습니다.
  • build.gradle에 asciidoctor 재생합니다.
    build/generated-snippets/기능명/메서드명 에 http-request.adoc, http-response.adoc 기타 등등 추가되었는지 확인합니다.

  • src/docs/asciidoc/index.adoc에 아래와 같이 추가합니다.

include::기능명.adoc[] //기능명은 도메인명
  • src/docs/asciidoc/기능명.adoc 추가(member.adoc 참고)합니다.
== 기능명
=== 기능명과 하나의 기능 
==== Request
include::{snippets}/기능명/http-request.adoc[]
==== Response
include::{snippets}/기능명/http-response.adoc[]
  • ./gradlew clean bootJar 실행합니다.

  • src/main/resources/static/docs에 index.html에 자신의 api가 추가되었는지 확인합니다.

  • application 돌리고 http://localhost:8080/docs/index.html에 접속해서 반영되었는지 확인합니다.

Clone this wiki locally