Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

API 가이드 문서 작성 시 참고할 사항을 정리한다.

목차 구성

다음 내용을 기본으로 목차를 구성한다.

  • 소개

    • 공통 요청

    • 공통 응답

    • (HTTP) 상태 코드

  • 시작하기

    • API 사용 절차

    • 인증

    • API 사용법

  • API 레퍼런스

    • API 개요(API 전체 요약)

    • 생성

      • 요청

        • 헤더

        • 본문(쿼리 파라미터)

        • 예제

      • 응답

        • 본문

        • 예제

    • 조회
      …

스타일 가이드

참고

  • No labels