REST API 返回布尔值的设计

REST API design for returning boolean values

我正在设计一个休息 api 将接受日期和 return 如果日期是假日或不是布尔格式。这个 be 的 url 模式应该是什么?

GET <domainname>/holidays?date=<mmddyyy>

应该是这样还是有更好的方法来设计url?

Should it be something like this or is there a better way to design the url?

机器不关心 - URI 只是一个标识符。像变量名一样,我们为了我们自己的利益而赋予它们人类可读的拼写。

也就是说,如果您要使用

这样的标识符
/a7c63fe6-ca28-4f21-9421-c9ca3df75658?yyyymmdd

然后一切都应该仍然有效。

使用 application/x-www-form-urlencoded key/value 对是一个不错的选择,因为 HTML 表单处理器了解如何构建这些 URI,因此它们可以 used/tested 通过网页.

?date=<YYYY-MM-DD>

但其他安排并没有错;我们只是有不同的权衡。

/holidays/date/<mmddyyy>

这种拼写可以让你通过相对引用找到有趣的东西。

假设您希望客户端创建这些 URI,您将需要符合 URI Template 规范的内容。

Randal Munroe strongly encourages 您鼓励日期拼写与 ISO-8601 一致。