Question

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

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

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

User {
  uid,
  name
}

另一个API定义文件：

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

然而，这些都是我自己的喜好。是否有任何常用的格式来表示这些？

我希望它与UML类似，不管语言如何，只关注API本身。

Answer 1

您提到的符号与开发人员期望作为设计或规范获得的符号非常接近，因此这可能就足够了。

但是，如果您的项目将获得一定的规模，您可以尝试使用某些符号，这些符号可能会被工具用于自动化代码生成，测试或文档。

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