[Team] API URL 정의

[ksundong]

API URL을 정의하려고 합니다.

• /api로 시작합니다.
• 그 다음 기능의 대상이 되는 대단위를 지정합니다. 현재는 /users
• 그 다음 구체적인 행동이 위치합니다. 유저 생성의 경우 /create
  /api/users/create 로 POST 요청을 보내면 User가 생성됩니다.

중복 체크에 대한 기능 url을 추천해주세요.

이 이슈에 API URL을 계속 정리하고, 이를 이용해 PostMan Docs를 만들어 볼 생각입니다.

[dev-Lena]

혹시 Get이 아니라 Post로 정하신 이유가 있나요? 👀

[ksundong]

REST API에 대해서 찾아보시면 되는데 POST 요청은 요청한 데이터를 생성해 달라고 서버에 요청하는 거라서 그렇습니다!

[dev-Lena]

아하 네! 아이디 중복 체크는 idCheck 나 check 어떤가요??
예시: /api/users/idCheck 또는 /api/users/check

[beginin15]

일단 테스트용으로 만든 api url 예시 입니다

중복 ID 체크 : GET /api/users/duplicate/userId/{중복체크할 아이디값}
중복 이메일 체크 : GET /api/users/duplicate/email/{중복체크할 이메일값}
중복 핸드폰 번호 체크 : GET /api/users/duplicate/phone-number/{중복체크할 핸드폰값11자리?}

수정 가능하니까 추천해주세용

[dev-Lena]

음... existanceCheck는 어떤가요? 좀 긴가요??

[beginin15]

duplicate보다는 check가 직관적일지도?

[ksundong]

음!! 보통 url은 동사형으로 많이쓰곤 합니다!
duplicate보다는 check가 더 동사적이긴 한데, 직관적인거랑은 거리가 멀다고 생각되네요!

[dev-Lena]

그럼 doubleCheck나 crossCheck는 어떠세요??👀

[ksundong]

doubleCheck crossCheck가 중복검사의 의미를 갖나요??
영알못 웁니다..

[dev-Lena]

사전 찾아보니까
Cross check: (정보·수치 등을 다른 방법을 써서) 대조[재차] 검토[확인]하다
Double check: 다시 한 번 확인하다, 재확인하다
인데 둘 다 중복검사의 의미는 안갖는 것 같네요😢
저 부분에 check repetitions / check duplicates는 좀 긴가요??

[ksundong]

길어도 상관은 없어요!

[beginin15]

테스트하기 원하는 요청 URL은 API 문서에서 확인하세요~
URL에 포함시켜서 전송하는지, Body에 포함시켜서 전송하는지 API에서 예시 보시면 될 것 같아요.
뭔가 이상하거나 설명이 필요하면 말씀해주세용!