type
status
date
slug
summary
tags
category
icon
password
정의
API의 기능, 동작, 사용법 등을 나타낸 문서
구성
- 이름 및 설명
- 이름
- 설명
- 기본정보
- Host 주소
- Endpoing
- HTTP Method
- Request
- Header
- Parameter
- Body
- Response
- Header
- Body
예제
해당 프로젝트와 무관환 개발자가 API 명세서만 보고도 사용할 수 있도록 구성되어 있어야 함
- API 설계를 먼저 하자 프론트엔드 개발자는 API 규격을 보고 작업한다 API 구현 기간 동안 API 호출 부분 작업을 못하거나 임의로 API 주소, HTTP method, 속성명을 사용하다가 모두 바꿔야 한다.
- API 설계할 때 소통하자 API를 사용하난 사람 입장을 반영하자. 네이밍, 반환타입, JSON 구조, 로직 적
- 업데이트를 사전에 공유하자
- 상대방 입장에서 설명하자 나와 다른 관심사를 다루는 프론트엔드 개발자 상대방이 가장 궁금해 할 내용을 상대방이 이해할 수 있도록 설명해야 함