REST API 엔드 포인트 - 이상한 경로 매개 변수

Question

나는 REST API와 URI 디자인을 배우고 난 여기에 하나를 발견했다 : https://raw.githubusercontent.com/JeanVEGA/MI-MPR-DIP-Admission/master/examples/requests.sh

내가 몇 가지 질문이 있습니다.

예를 들어 있습니다 :

User.resetPassword, 사용자의 {이메일}에 의한 익명

curl -i -X POST http://localhost:9090/admission/services/user/person/email:{email}/reset_password 

I 건축 email:{email}을 이해하지 않는다 ... 그것은 무엇을 의미합니까? 즉, String path 매개 변수가 있으면이 방법으로 처리해야합니다. 마찬가지의

가 여기에 있습니다 :

Term.get

curl -i -H "Accept: application/json" -H "X-CTU-FIT-Admission-Session: [session identifier from User.identity]" http://localhost:9090/admission/services/term/dateOfTerm:{dateOfTerm}/room:{room} 

room:{room} - 방 예를 123ABC 위해해야하기 때문이다? 그래서 그것은 숫자가 아니기 때문에 이렇게 쓰여질 필요가 있습니까?

그리고 내 마지막 질문 : 입학 코드에 의한 사용자에 대한

User.resetPassword, 사용자의 이메일로 알림을 보내이 {이메일} 질문

curl -i -H "X-CTU-FIT-Admission-Session: [session identifier from User.identity]" -X POST http://localhost:9090/admission/services/user/admission/{admissionCode}/person/email:{email}/reset_password 

내 poiont는 "reset_password"입니다 ... 나는 올바른 디자인 원칙으로 인해 동사가 URI에 없어야한다고 생각했다. 왜냐하면 동사가 URI에 있기 때문에 리소스가 실제로 작동한다는 것을 의미하기 때문이다.

Answer 1

해당 URL은 리소스 식별자 일 수 있습니다. 따라서 고유 한 이메일 주소를 매개 변수로 대기하는 url template입니다. 템플릿에 가득은 다음과 같이 보일 것이다 :

이

./person/email:my@email.adr/reset_password 

참고 : reset_password가 유효한 REST 자원 아닙니다

가와 POST 방법 (가 서비스하지 않는 자원을 설명하는) mostly for resource creation (아니다 업데이트 또는 부분 업데이트). 실제 REST 요청은 다음과 같이 :

PUT ./person/email:{email}/password "newpass" 
PUT ./person/{id}/password "newpass" 
PUT ./person/email:{email}/identification_factors/password "newpass" 
PATCH ./person/email:{email}/identification_factors {password: "newpass"} 

등등은 ...