API 스펙 설계 - 1

[wonyongChoi05]

API 스펙 관리에 대해

1. 코드로 관리

   • Swagger (자바 어노테이션 기반)
   • Spring Rest Docs (스프링 테스트 코드 기반)

2. Rest Client Tool 이용

   • Postman..

3. 문서로 관리

   • 스프레드 시트
   • 노션 ..

모든 경우 장단점이 존재한다.

• 복잡하거나 간단하거나
• 빠르거나 오래걸리거나
• 상황에 맞게 진행하되 지속적으로 개선해나가는게 중요할 듯

Restful API에 대해

REST API를 구성하는 요소가 정말 많다.

• 그것들을 모두 적용해야 할지는 상황에 따라 많이 달라짐

몇가지 틀징을 가지도록 설계하기도 하겠음

• 한 리소스의 CRUD에 대한 http method, path를 정의하는 컨벤션 지킴