피드백 정리

처음으로 API를 작성한 뒤에 받은 피드백들을 정리해보려고 한다.
우선 다음은 초기에 작성한 API 명세서이다.
REST API에 대해서 정리를 하고도 많은 실수를 했다.

1. URI에는 동사가 들어가지 않는다.
2. URI에는 대문자를 사용하지 않는다.
3. URI는 복수형을 지향한다.
4. 전체 카테고리 조회같은 경우에는 데이터를 따로 추출하는 것이 아니기 때문에 클라이언트가 처리한다.
5. 매장 조회의 옵션은 쿼리스트링을 통해 하나의 API로 정의한다.
6. status의 경우에는 본인만 알아볼 수 있는 0,1,2 보다는 클라이언트도 알아보기 쉬운 ACTIVE, INACTIVE, DELETED로 표현하는 것이 적절하다.
7. Validation을 조금 더 구체적으로 작성해야 한다. ex) 중복 확인, 입력값에 대한 에러 등

이런 실수들을 고치고 JWT와 Transaction을 적용하여 API를 다듬어보았다.

API 다듬기

쿼리스트링을 통해서 작성했던 API를 하나로 묶으니 API 갯수가 많이 줄었다. 그래서 추가적으로 API를 작성하였다.

API를 다듬으면서 구체적이지 못했던 부분, 부족한 부분, 에러가 검출되지 않는 부분들을 많이 찾을 수 있었고, 여러번 수정하였다.

물론 처음부터 완벽한 API를 작성하는 것도 중요하지만, 작성 이후 여러번 검토를 통해 부족한 점을 찾아내는 것도 중요하다는 것을 다시금 느낄 수 있었다.