•
양식을 설명하는 부분은 각 내용의 오른쪽에 인라인 코드 처리 하여 작성하였다. (설명)
•
추가적인 설명은 콜아웃으로 추가적으로 작성하였다.
이게 콜아웃이다.
텍스트 양식은 아래의 양식을 따른다.
•
큰 제목은 (제목2) 로 사용
◦
서브 제목은 (제목3) & 글씨 색 회색 처리 한다.
서브 제목이 1개일 땐 작성하지 않는다.
1개의 API당 하나의 토클을 사용한다.
API의 이름 맨 왼쪽에는 어떤 메소드를 사용하는지 작성한다. 메소드 이름의 규격은 예시에 작성하였다.
이게 토클이다. (펼쳤다가 접을 수 있다.)
하나의 API Docs에 작성되는 내용은 아래와 같다.
•
Service
•
API Version
•
Method(큰 제목)
•
Path(큰 제목)
•
Example Endpoint(큰 제목)
•
Header(큰 제목)
•
Cookie(큰 제목)
•
Require(큰 제목)
◦
Path Variable (서브 제목)
◦
Query string (서브 제목)
◦
Body (서브 제목)
•
Response(큰 제목)
◦
Message (서브 제목)
◦
Example (서브 제목)
•
Error(큰 제목)
작성 예시
설명과 함께 API Docs를 작성한 예시이다.
GET ID 중복 체크 (이름 가장 왼쪽에 어떤 메소드를 사용하는지 작성) & Bold 처리
API Docs Template
내용 없이 API Docs의 양식을 갖춘 Template이다.
해당 Template을 복사하여 내용을 추가하여 API Docs를 작성하면 된다.
GET Example API