java - 何时使用 pathParams 或 QueryParams

Question

这个问题在这里已经有了答案:

When to use @QueryParam vs @PathParam (18 个回答)

关闭 4年前。

对于何时应该对 URL 使用路径参数以及何时应该使用查询参数，是否有经验法则？

假设我有一张带有字段 company(PK)、InvoiceNo(PK)、Invoiceline、invoiceValue、noOfLines、salesPerson 的表格 Invoice

我目前的想法是您的网址应该符合

/Invoice/

显示所有发票

/Invoice/{company}

这将显示公司的所有发票。

/Invoice/{company}/{InvoiceNo}

显示特定发票和

/Invoice/{company}/{InvoiceNo}?invoiceLineNo=23

仅显示第 23 行。

我的想法是主键字段应该是路径的一部分，而您要过滤的任何其他字段都是查询参数的一部分。

这听起来像是区分两者的合理方法吗？

Answer 1

我个人的经验法则是 PathParam 会导致您请求的实体类型。

/Invoices             // all invoices
/Invoices?after=2011  // a filter on all invoices

/Invoices/52          // by 52
/Invoices/52/Items    // all items on invoice 52
/Invoices/52/Items/1  // Item 1 from invoice 52

/Companies/{company}/Invoices?sort=Date
/Companies/{company}/Invoices/{invoiceNo} // assuming that the invoice only unq by company?

引用 Mr Rowe : 分组数据的路径参数，过滤的查询参数