REST-什么是RESTful API设计的标准文件格式？_Rest

REST-什么是RESTful API设计的标准文件格式？

rest

REST-什么是RESTful API设计的标准文件格式？,rest,Rest,我想将我的设计存储为文件以进行版本控制是否有任何标准或常用格式例如，我可以为结构定义编写一个文件： User { uid, name } GET /users/:uid => User GET /users?name=:name => [User] 和另一个API定义文件： User { uid, name } GET /users/:uid => User GET /users?name=:name => [User] 然而，这些都是我自己的

我想将我的设计存储为文件以进行版本控制

是否有任何标准或常用格式

例如，我可以为结构定义编写一个文件：

User {
  uid,
  name
}

GET /users/:uid => User
GET /users?name=:name => [User]

和另一个API定义文件：

User {
  uid,
  name
}

GET /users/:uid => User
GET /users?name=:name => [User]

然而，这些都是我自己的偏好。有没有常用的格式来表示这些

我希望它类似于

UML

，而不管语言如何，只关注API本身。

您提到的符号非常接近开发人员期望的设计或规范，所以这可能就足够了

然而，如果您的项目将达到一定规模，您可以尝试使用一些符号，这些符号可能会被工具用来自动化代码生成、测试或文档

特别是，Swagger是一个非常常用的工具。如果您按照这些标准编写规范，您将获得文档，如果您使用该工具，甚至可以生成一些代码

许多公司用于设计rest api的一种常见模式与Microsoft完成的模式类似，您可以在此处查看文档：