用于返回布尔值的REST API设计

时间:2019-07-19 17:42:47

标签: rest api api-design api-gateway

我正在设计一个rest api,它将接受日期,如果日期是假日或不是布尔格式,则返回。网址格式应该是什么?

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

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

1 个答案:

答案 0 :(得分:1)

  

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

机器不在乎-URI只是一个标识符。像变量名一样,为了我们自己的利益,我们为它们提供了易于阅读的拼写。

这就是说,如果您要使用类似的标识符

/a7c63fe6-ca28-4f21-9421-c9ca3df75658?yyyymmdd

然后一切仍然应该正常工作。

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

?date=<YYYY-MM-DD>

但是其他安排没有错;我们只是权衡取舍。

/holidays/date/<mmddyyy>

该拼写允许您通过相对引用来有趣的事情。

假设您打算由客户端创建这些URI,则需要与URI Template规范相符的内容。

Randal Munroe strongly encourages,鼓励您使用符合ISO-8601的日期拼写。