Web API设计与开发实践指南
Web API的设计与开发说明丰富了附录B中的Web API检查清单，提供了必要的解释和说明，便于快速掌握要点。以下是一些重要的设计建议：
URI设计最佳实践
-
URI是否简洁易输入：
- 好的例子：
http://api.example.com/search - 不佳的例子：
http://api.example.com/service/api/search。 - 注意：既然域名包含了“api”，URI中就不应重复无意义的单词。
- 好的例子：
-
URI是否易读和理解：
- 避免不明缩写，例如：
http://api.example.com/sv/u。 - 使用常用的英文表达，比如搜索接口应使用
search而非find，可多参考国外大厂的API命名。
- 避免不明缩写，例如：
-
URI是否全部小写：
- 根据HTTP协议，URL中除了
schema和hostname不区分大小写，其他部分则大小写敏感，因此URI需小写，避免大小写混用。
- 根据HTTP协议，URL中除了
-
URI是否便于扩展：
- 获取某个商品信息的URI示例：
http://api.example.com/v1/items/12346。这种URI形式清晰易懂，可直接替换商品ID获取其他商品信息。
- 获取某个商品信息的URI示例：
设计注意事项
结合实际情况，适度调整以提升使用体验。以上检查清单仅为建议，务必根据实际需求应用。
文件大小：9.57KB
评论区