RESTful API _ 실전 적용하기

박민우·2022년 4월 13일
0

모아부자

목록 보기
2/9


RESTful API

첫 번째 API 설계

RESTful API. 정말 많이 듣는 이야기이기에 처음부터 잘 해보려고 했다. 그런데 쉽지 않았다.
서로가 RESTful API에 대해 제대로 알지 못한 상태였고, 서비스 전체가 확실하게 그려지지 않았기에 API 설계 자체도 어려웠던 것이 큰 맹점이 아니었을까.

전체 서비스가 그려지지 않은 상태에서 API 설계는 컨벤션 자체도 많이 무너진다. 용어에 대한 확립이 되어있질 않으니, 'challengeGoal' 하나를 적어도 challenge 라고 적었다가 challengeGoal이라고 적었다가 -

그래서 우리 서비스는 수정이 너무너무 갈급했다.
api를 처음부터 마지막까지, 다시 하나하나 살폈다. 이 때 최대한 RESTful API에 대해 찾아보고 적용할 수 있는 부분들을 적용하고자 하였다.

처음 api를 정할 때는 / 슬래시 구분자와 행위에 대해서 다 표기했었다. 그리고 {id} 와 같이 Path 값으로 id가 들어가기라도 하면 맨 끝에 빼는 것이 당연한 것처럼 여겼다.
그런데 RESTful한 API에 관련된 자료를 조금만 찾아보면 / 슬래시 구분자로 계층 관계를 나타낸다는 것을 알 수 있다. 그리고 행위에 관한 것들은 다 빼주는 것이 좋다. 그래서 최대한 깔끔하게, 의미를 분명히 하되 중복되지 않고 쓸데 없는 부분들은 제외하려고 했다.
그리고 리소스 연관 관계를 생각하며 /group/{id}/accept 이런 모양의 api들을 만들었다. (group에 id의 값을 accept 하는 구나- 라고 읽을 수 있다)

계속해서 공부를 하며 API 수정에 시간을 쏟기에는 RESTful 하다는 것의 명확한 정답이 없고, 서비스를 개발하기에도 시간이 부족했기에. 깔끔하게 할 수 있는 만큼 정리했었다. 이후 개발하는 데에도 자잘한 부분들이 안 맞아서 프론트와 소통으로 시간을 허비하지 않아서 좋았던 것 같다!

수정 후 API


참고 글
참고 블로그 1
참고 블로그 2

profile
KingdomOfGod newPerson = new KingdomOfGod();

0개의 댓글