确定给定上下文的REST端点资源

Question

我无法为otp服务命名其余端点。

在这里我有4个端点，在括号中给出了输入

1. SEND API（Mo. No.）-生成OTP并发送到手机号码，作为响应，它提供TransactionId
2. RESEND API（TransId）-使用transactionId将相同的OTP重新发送到手机号码
3. VERIFY API（OTP，TransId）-验证为transactionId指定的OTP是否与高速缓存中存储的内容正确
4. ISVERIFIED API（TransId）-检查特定的transactionId是否经过验证

任何人都可以告诉我如何为这些API制作REST端点，遵守REST资源原则等。

我想到了

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

很显然，这不是一个很好的端点设计，我需要一些帮助

Answer 1

更好的方法是

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

POST v1 / is-verified-transaction，如果您需要为每个端点创建单独的端点

否则，因为它们可以是同一端点的一部分，只有有效载荷可以不同，所以您可以执行

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

Answer 2

也许您应该以{{1​​}}和otp作为资源并执行以下操作：

transaction

我不确定otp和事务之间的关系，所以可能有点偏离，只是抛出了将它们作为资源的想法