API 명세

<aside> ✅ API에 있어 백과 프론트 사이 데이터를 주고 받는 방식을 보여주는 명세

</aside>

(endpoint가 되는 url, 필요한 parameter, 요청정보,응답정보 등등..)

백과 프론트 사이 사용하는 API에 대한 소통을 위해 GIT만큼 필수이며 중요하다.

서버개발자의 API 개발 이후 또는 개발과 함께, 클라이언트 개발을 하는 프론트 개발자에게 API의 사용법을 알려줘야 한다.

API 명세가 필요한 이유

• 개발에 착수하기 전에 구조에 대해 고민할 시간이 생긴다.
• 어차피 API 스펙을 프론트엔드에게 전달할 때는 문서로 정리해야 한다.
• 실제로 로직을 작성하기 전에 스펙을 리뷰하는 단계가 생기고, 아직 코드를 작성하지 않았으니 변경 사항을 빠르게 반영할 수 있다.
• 문서를 착실하게 작성해 두면, 커뮤니케이션으로 낭비하는 시간이 줄어든다.

API 명세 도구들

Swagger

• 대표적인 API 관리 도구, OAS를 위한 프레임워크

  문서 자체에 API를 test할 수 있는 환경이 있음

  API Spec 문서를 자동화할 수 있음

  모든 API를 한 페이지(파일)에서 관리해야해서, 라인이 길어지면 관리가 힘들다?(확인아함)

Slate

Redoc(Swagger 기반)

Flasgger(Swagger 기반)

Postman

API 명세서 공유 및 API 테스트 가능

collection -> view in web + publish 기능