api - REST API の適切なリソース名

Question

請求書 API を作成しているとしましょう。より適切なリソースは何ですか?

GET

• 支払済み_請求書
• due_invoices
• all_invoices

また

GET

• 請求書/すべて
• 請求書/期日
• 請求書/支払済み

---

追加の質問: API で請求書を支払い済としてマークできる場合、適切なリソースは何ですか?

PUT //where 3 is the id

• 請求書/3

また

PUT

• pay_invoice/3

Answer 1

私はこう言います：

• GET /invoicesすべての請求書を返します。
• フィルターは、支払い済みまたは期限切れの請求書を返すことGET /invoices?state=paidがstateできpaidますdue。

請求書を支払い済としてマークするには、対応する状態をリソースに設定し、PUT /invoices/<id>.

または、リソースにパッチを適用することもできます: PATCH /invoices/<id>. state=paidこのメソッドには、たとえば次のような差分が必要です。

API に何を送信するか (完全なリソース、または適用する変更のみ) が問題です。

REST 以外のソリューションは、 へのPATCHリクエストを実行すること/invoices/<id>/paidです。純粋な REST ではありませんが、問題ありません。