API 문서 작성 시 참고 사항

Owned by 유재형
Last updated: 2023/07/26
1 min read

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

목차 구성

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

  • 소개

    • 공통 요청

    • 공통 응답

    • (HTTP) 상태 코드

  • 시작하기

    • API 사용 절차

    • 인증

    • API 사용법

  • API 레퍼런스

    • API 개요(API 전체 요약)

    • 생성

      • 요청

        • 헤더

        • 본문(쿼리 파라미터)

        • 예제

      • 응답

        • 본문

        • 예제

    • 조회
      …

 

요청(Request)

  • 헤더(Header)

  • URI 경로(Path):

  • 쿼리(Query): GET인 경우

  • 본문(Body): POST인 경우

  • 예제: curl 명령어

응답(Response)

  • 본문

  • 예제

참고