Определение ресурсов конечных точек REST для данного контекста - PullRequest
Новая
       13

Определение ресурсов конечных точек REST для данного контекста

0 голосов
/ 19 февраля 2019

У меня проблемы с присвоением имен остальным конечным точкам для моей службы otp.

Здесь у меня есть 4 конечные точки, в скобках я ввел входные данные

  1. SEND API (Mo. №)- Генерирует OTP и отправляет на номер мобильного телефона, в ответ выдает TransactionId
  2. RESEND API (TransId) - Повторно отправляет тот же OTP на номер мобильного телефона с ID транзакции
  3. VERIFY API (OTP, TransId) - Подтвердитеесли OTP, заданный для идентификатора транзакции, соответствует тому, что хранится в кэше
  4. ISVERIFIED API (TransId) - Проверьте, проверен ли конкретный идентификатор транзакции или нет

Может кто-нибудь сказать, пожалуйстакак мне создать конечные точки REST для этих API, придерживаться принципов ресурсов REST и т. д.

Я думал о

  1. POST v1 / sendOTP
  2. POSTv1 / resendOTP
  3. POST v1 / verifyOTP
  4. POST v1 / isVerifiedTransaction

Очевидно, это не очень хороший дизайн конечных точек, мне нужна помощь

Ответы [ 2 ]

0 голосов
/ 19 февраля 2019

Может быть, вы должны иметь otp и transaction в качестве ресурсов и сделать что-то вроде этого: 

POST v1/otp/send
POST v1/transaction/{transId}/resend
GET v1/transaction/{transactionId}/verify?otp={otpId}
GET v1/transaction/{trandId}/isVerified

Я не уверен, как соотносятся OTP и транзакции, так что это может быть немного не так, простобросая идею иметь их как ресурсы

0 голосов
/ 19 февраля 2019

Лучшим подходом было бы 

POST v1/send-otp
POST v1/resend-otp
POST v1/verify-otp

POST v1 / is-validated -action, если вам нужно сделать отдельную конечную точку для каждой

, иначе они могут быть частью одного и того же конца- точка только полезная нагрузка может отличаться, вы не можете сделать что-то вроде 

POST v1/otp?action=send
POST v1/otp?action=re-send
POST v1/otp?action=verify
POST v1/is-verified-transaction or v1/transaction?status=is-verified
...