Swagger，API Blueprint,RAML……如何保持API规范和实现的同步？
但是，如果在实现过程中，由于某些原因，您最终不得不更改API的签名，例如更改响应体模型，该怎么办？我的意思是，在这种情况下，您的API规范需要更改，您必须手动编辑API规范，以便与代码保持同步，因为似乎没有成熟的库可以从源代码生成API规范。（我已经为Swagger和RAML测试了这样的库，但没有测试APIB，因为我找不到JAX-RS source-APIB转换库。）遇到上述情况，你是如何处理的？
您是手动编辑API规范还是使用某个库自动完成？如果是后者，你能告诉我图书馆的名字吗？
共有1个答案
如果您想确保API描述和文档同步，请务必查看Dredd。
Dredd的口号是：
不再有过时的API文档
-
我们正在研究是否可以使用Jenkins CI服务器将Postman Test Runner和Neuman合并到api测试流中。
-
我开发了一个带有Swagger注释的REST API。我已经能够展示一个炫耀的ui应用程序的api文档，非常好。 问题:根据我的注释，我试图使用swagger提供的url生成符合该规范的客户端。问题是，它似乎是不兼容的，或者至少，我不知道如何做swagger编辑器读取我的网址，并从那时起，产生客户。但是swagger编辑器向我报告了一些错误... 是否可以将我的带注释的 swagger api 与
-
我们对不同的项目使用基于Swagger的REST API规范。因此，每个项目都有自己的Swagger UI，其中包含endpoint描述。所有这些UI都部署在不同的服务器上，使用不同的域名，从组织的角度来看一点也不酷。 有什么好的选择可以在一个地方存储多个Swagger规范吗？它可以是使用Swagger规范的REST API描述管理的任何服务。
-
我想问是否有一种方法可以简单地从不同的API中聚合OpenApi规范？ 目前，我们为每个API添加了用户招摇过市的功能，并在其中添加了用于身份验证的自定义逻辑，我们还为不同的可访问性规则添加了规则。 然而，以某种方式聚合所有这些API，并将身份验证、访问逻辑保持在同一位置，会更方便。 例： 我们有两个独立的微服务，有独立的API和独立的地址 API 1localhost:5000 使用Orders
-
我试图用一个静态的swagger文件来记录一个API，该文件可以返回一些JSON，其中包含一个类似如下的数组: 我尝试了几种不同的方法来定义规范，使用多态性或显式定义多个示例。这些例子要么最终看起来像： 或者只是: 有没有办法在我的swagger规范中定义一个示例，以便swagger-ui显示的示例有效负载将包含一个数组，该数组包含一个A类型的示例和一个B类型的示例，就像我编写的第一个JSON一样
-
我正在为一个新endpoint创建一个招摇规范，该endpoint将接收一个作为二进制数据的文件。你会如何在夸张的规范中表达这一点？我将对象视为数据类型，但这似乎不是我要寻找的。过去有人这样做过吗？ 据我所知，这个问题不是重复的，因为它专门涉及二进制或“blob”对象类型。