반응형 API1 API 문서 작성하는 방법 프로젝트를 진행하면서 API 문서를 작성하는 방법에 대해서 공부했다. 프로젝트 repository wiki에 업로드하여 팀원 모두와 공유하기로 하고 API document를 작성하는 방법에 대해서 검색을 해봤다. 그러던 중 좋은 자료를 발견하였고 이에 맞춰서 wiki를 작성했다. (자료 출처 : gist.github.com/iros/3426278) 먼저 꼭 들어가야 하는 내용들이다. API Title - api 이름 URL - api 경로 Method - request 방식 (get | post | delete | put) Data Params - post 요청시 body안에 넣어줄 값 URL Params (만약 있을 경우) Required - url params로 넘길 값 Success Response.. 2020. 12. 30. 이전 1 다음 반응형