API 문서 작성하기

필수 내용

• API Title - api 이름
• URL - api 경로
• Method - request 방식 (get | post | delete | put)
• Data Params - post 요청시 body안에 넣어줄 값
• URL Params (만약 있을 경우)
  • Required - url params로 넘길 값
• Success Response - 응답이 성공적으로 반환될 경우 반환되는 값과 코드
• Error Response - 응답이 성공적이지 못할 경우 반환되는 값과 코드
• Sample Call - 요청과 응답의 예시

 

(자료 출처 : gist.github.com/iros/3426278)