스니펫을 사용해서 API 문서 만들기
1. 템플릿 문서 생성 (Gradle의 경우 디폴트는 src/docs/asciidoc)
2. 템플릿 문서에 내용 추가
3. build 혹은 bootJar를 통해 템플릿 문서를 html로 변환
= 타이틀 // 문서의 타이틀. '='의 갯수가 늘어날수록 글자의 크기는 줄어든다
:sectnums: // 각 섹션에 넘버링 설정
:toc: left // 목차의 위치
:toclevels: 4
:toc-title: Table of Contents //목차의 제목
:source-highlighter: prettify
저자 <test@test.com> // 문서의 생성자
v1.0.0, 2023.07.04
*** // 단락을 구분하는 가로줄 추가
== MemberController
=== 회원 등록
.curl-request
include::{snippets}/post-member/curl-request.adoc[]
.http-request
include::{snippets}/post-member/http-request.adoc[]
.request-fields
include::{snippets}/post-member/request-fields.adoc[]
.http-response
include::{snippets}/post-member/http-response.adoc[]
.response-headers
include::{snippets}/post-member/response-headers.adoc[]- 문단의 제목 다음에 개행 후 한 칸 들여쓰는 문단을 작성하면 박스 문단
- 경고 문구 등을 추가할 수 있다. e.g. CAUTION: NOTE: TIP: IMPORTANT: WARNING:
요 근래 공부한 테스트, api 문서화를 전부 사용한 과제
https://github.com/hong95995/be-homework-api-documentation
