api-design-best-practice:[英文版]编写API时的最佳做法

时间:2024-03-07 19:59:34
【文件属性】:

文件名称:api-design-best-practice:[英文版]编写API时的最佳做法

文件大小:2KB

文件格式:ZIP

更新时间:2024-03-07 19:59:34

编写API的最佳做法 编写API时应考虑的一些要点: 为人类而写。 例如: /users/{id}/card-number而不是/users/{id}/pin 。 应使用小写字母。 例如: /users/{id}/pending-orders而不是/users/{id}/Pending_Orders 。 用破折号分隔单词。 例如: /users/{id}/pending-orders而不是/users/{id}/pending_orders 。 遵循类似于文件夹结构的命名模式。 使用层次结构。 在设计API时请记住,要维护API中的版本号。 没有尾随的正斜杠。 例如: /users/{id}/pending-orders而不是/users/{id}/pending-orders/并且两者都应提供相同的输出。 命名 资源应该是nouns而不是verbs 。 例如:/


【文件预览】:
api-design-best-practice-main
----README.md(4KB)

网友评论