Page history of REST API 문서화

Preview HTML

Diff with current

---

Title: REST API 문서화 | edited by Youngrok Pak at 10 years, 4 months ago.

<p>REST API 문서화는 세 가지 관점에서 고려한다.</p>
<ul>
<li>API 서버 소스코드</li>
<li>API 문서 브라우징</li>
<li>API 테스트 드라이브</li>
</ul>
<p> 그리고 다음과 같은 요구사항을 만족해야 한다.</p>
<ul>
<li>문서의 기본 골격은 소스코드에서 생성하며, 소스코드에서 알 수 있는 내용은 수동으로 입력하지 않는다.</li>
<li>소스코드에서 생성한 문서에 쉽게 코멘트나 포맷팅 가능한 설명을 추가할 수 있다.</li>
<li>문서는 파싱해서 API 테스트 UI를 자동 생성할 수 있다.</li>
</ul>
<p>필요한 정보</p>
<ul>
<li>Data schema description language for request and response</li>
<ul>
<li>primitive types</li>
<li>list or dictionary</li>
<li>reference to other type</li>
</ul>
<li>request parameter spec</li>
<ul>
<li>url parameter</li>
<li>form field</li>
<li>header</li>
<li>cookie</li>
</ul>
</ul>