API 설정 규칙 통일

[kgh2120]

API를 설정하고 있는데 같은 내용이라도 표현할 수 있는 방식이 너무 많아서 고민이네
예를 들어서 친구 추가 같은 경우
[POST] /friend/request 라는 url을 기반으로 해서 아래와 같은 경우가 될 수 있음.

1. [POST] /friend/request/{nickname}
2. [POST] /friend/request body : nickname

정보를 받는 방법으로는 pathvariable, pathparameter, body가 있는데, 주로 사용하는 경우가 있다고는 하지만 무엇보다 통일성이 유지되는 것이 제일 중요하다고 함.

어떤 방식이 좋을까? 상황에 따른 API 명명 규칙을 정합시다.

[jinlee0]

만약 어떤 resource를 식별하고 싶으면 Path Variable을 사용하고,
정렬이나 필터링을 한다면 Query Parameter를 사용하는 것이 Best Practice이다.

nickname, email은 식별자니까 path variable로 하는게 맞나?

/friend/{id}/requset/{otherId}
이게 기본이라 치면.. 내 아이디는 토큰으로 대체 되고 상대 아이디 대신 닉네임이나 이메일 받을 수 있으니까

/friend/my/request/by-email/{email}
/friend/my/request/by-nickname/{nickname}
이런식은 어때?

[kgh2120]

음 그럼 특정 대상이 있는 경우엔 path variable을 쓰고 정보를 넘겨야 하는 경우엔 body로 넣어야겠다.
친구 검색은 아마 닉네임만 쓰는거 같았고, my는 생각해보니 auth이후에 모든 기능에서 토큰이 사용되니까 계속 사용할 필요가 있나 싶네

[kgh2120]

정보 넘길 때 get의 경우엔 path parameter를 사용하고 그 외엔 body로 써야겠다