openapi

0热度

1回答

我可以成功将以下OpenAPI定义导入到Azure API管理中。但是，当我导出OpenAPI定义时，“架构”名称已从“响应”对象中删除。因此，我的门户中的开发人员未显示此操作的架构或示例。如果将我的API定义添加到the official editor，那么我的API定义是有效的并且功能正确。如何防止模式被剥离？ { "swagger": "2.0", "info":

1热度

1回答

openapi v3响应正文中的多行示例

有没有在请求正文中编写多行示例的方法？如果可能的话，我希望我的OpenApi文档在Swagger-UI下运行时显示如下。到目前为止，我已经能够做到的，是一个单行例子，如下所示：

0热度

1回答

如何从另一个模式继承模式属性？

我使用ReDoc来使用OpenAPI 2（Swagger）JSON文件可视化API文档。我试图通过包括第一模式到第二个如下声明两个请求输入参数： ... "definitions": { "list-request": { "type": "object", "properties": { "token":{ "type": "st

1热度

1回答

什么时候应该使用$ ref与Open API中的对象ID

我正在使用Swagger处理OpenAPI中的模式，并且我不确定是否滥用了$ref元素。我有一个User模型和Project模型，类似于像 User: type: object properties: id: type: string format: uuid name: type: string

1热度

1回答

验证OpenAPI是否符合REST设计最佳实践

我们正在使用Swagger从源代码生成API文档。我现在想知道是否有任何工具会自动检查生成的OpenAPI文档（= Swagger JSON）与RESTful API设计最佳实践的符合性。例如Zalando已经在这些准则所定义的REST设计一个公开的指导方针在我看来有可自动检查基础上，OpenAPI的规格很多规则： “不要向后打破兼容性“可以在不同版本的OpenAPI 文件进行比较时进行检查。

4热度

1回答

如何在swagger propertise中添加多个示例值？

我使用扬鞭OpenAPI的规格工具，我有一个字符串数组属性中的定义之一如下： cities: type: array items: type: string example: "Pune" 我的API产生JSON结果因此对于下面的结果上述对象出现在响应： { "cities": [ "Pune" ] } 试

3热度

1回答

Swagger/OpenAPI：如何在构建过程中整合生成打字稿/角度客户端？

的Java /春服务器存根生成与招摇，CODEGEN - Maven的插件在我的春天启动的Java项目，我使用swagger-codegen-maven-plugin产生从我扬鞭2.0 API的Spring MVC的控制器接口（服务器存根）。阳明海运。 Maven构建过程中的集成非常简单。它的工作原理与我以前用WSAX的jaxws-maven插件完成的一样。这是使用swagger-codegen

1热度

1回答

OpenAPI的再利用部分不定义一个新的

假设我有一个YAML的OpenAPI定义 definitions: User: description: "User" type: "object" properties: firstname: type: "string" lastname: type: "string" password:

1热度

1回答

如何在OpenAPI/Swagger中指定递归路径

我想为我的Swagger API创建递归规范。这个概念似乎从the Swagger documentation缺席，所以我怀疑这是不可能的。所以我也愿意接受Swagger支持的其他解决方案。例如，我试图创建一个类似文档的结构。每个文档都有部分，每个部分都有文本和它自己的部分。我打算在具有API端点这样的： http://a.b.com/docs/ {文档ID} http://a.b.com/d

1热度

1回答

在Open API 3.0规范或Swagger编辑器中，“注释”是一个受保护的词吗？

我目前正在使用Swagger Editor（v3.1.9）和Open API 3规范开发API规范。我得到一些特殊的行为专门为架构组件我有一个名为Comment Comment: description: "A comment on an asset or submission" allOf: - $ref: "#/components/schemas/Messag