REST API URL 命名約定

Question

我想通過檢索訂單詳細信息來檢查訂單是否處於活動狀態。 我有一個設計類似於下面列出的端點

/order/{order-id}

但是，我要在不檢索訂單詳細信息的情況下檢查訂單是否處於活動狀態。 以下哪一項是更好的方法，還是有其他選擇？

/order/{order-id}/is-active

或者

/order/is-active/{order-id}

Answer 1

Django Rest Framework, a widely used REST API framework, uses the second form /order/{order-id}/is-active .

有關額外操作的路由和反向操作 URL ，請參閱其文檔中的示例。