RESTful API 명세 템플릿

hi·2023년 6월 18일
0

API 설계

목록 보기
2/14

API 이름

[API 이름]

API 개요

[API에 대한 간단한 설명]

엔드포인트

[HTTP 메서드] [엔드포인트 URL]

요청

요청 헤더

[헤더 필드]: [값]

요청 바디

[요청 바디 예시]

매개변수

[매개변수 이름]: [타입] - [설명]

응답

응답 헤더

[헤더 필드]: [값]

응답 바디

[응답 바디 예시]

상태 코드

  • [상태 코드]: [설명]

예시

요청 예시

[요청 예시]

응답 예시

[응답 예시]

오류 처리

[오류 처리에 대한 설명]

보안

[API 보안에 대한 설명]

인증

[API 인증에 대한 설명]

Rate Limiting

[Rate Limiting에 대한 설명]

버전 관리

[API 버전 관리에 대한 설명]

변경 이력

[API의 변경 이력]

0개의 댓글