목록API 명세서 (1)

개발하는 무민

[API] API 문서 작성 요령 익히기

회사에서 API 를 구현하며 swagger와 API 명세서를 작성하고 있는데, 기본적인 작성 방법과 요령을 인지해두는 것이 좋을 듯 해서 카카오 테크니컬라이팅 팀에서 작성한 API 문서 톺아보기 게시글을 참고하여 정리해보고자 한다. API(Application Programming Interface) 서버와 클라이언트가 데이터를 주고 받을 수 있도록 도움을 주는 매개체 일반적으로 정해야 하는 규칙 → 메시지의 데이터 형식은 무엇이고, 글자수 제한이 있다면 몇 자인지, 어떤 방식으로 데이터가 전달되어야 하는지, 요청에 대한 결과는 어떤 형식으로 확인할 수 있는지 API는 단순 기능들을 나열한 명세서가 아니라, 어떤 동작을 하고, 어떤 목적을 위한 것인지, API 사용 전 수행할 사전 작업이 있는지 등의 충..
Development 2022. 12. 16. 14:04
이전 Prev 1 Next 다음