使用 Swagger/OpenAPI 创建可扩展模型
在我的 API 中，我想为我的收藏提供一个简单的模型，并为我的个人资源提供一个更精细的模型.例如: /libraries 上的 GET 请求应返回 BaseLibrary:类型:对象特性:library_id:类型:字符串描述:图书馆的id显示名称:类型:字符串描述:图书馆名称参考资料:类型:字符串描述:链接到这个库的 URI. 虽然对特定库的请求应返回上述所有内容，包括额外的参数boo
..
swagger相关内容
Swagger 未检测到使用 Spring Data Rest 构建的 Api
我正在开发一个使用 swagger 为我的 API 生成文档的 Spring Boot 应用程序，我正在使用 Spring data rest 来生成 Api，但是当我运行该应用程序时，我收到了 swagger 消息:没有定义操作符合规范！ 这是我的 Api 代码: @Api(tags = "projets")@RepositoryRestResource(collectionResour
..
Swashbuckle MapType<类型>不适用于参数
我有一个将 ShortGuid 类作为参数的 API 端点，如下所示: [HttpGet("api/endpoint")]公共异步任务GetTablesAsync(ShortGuid id){} 生成一个大摇大摆的定义: “参数":[{“名称":“指导"，“在":“查询"，“必需":假，“类型":“字符串"，“格式":“uuid"},{“名称":“值"，“在":
..
Swashbuckle + XmlComments 在本地工作，但在服务器上生成招摇失败
我有一个 webapi 项目，我正在使用 swashbuckle 框架来清除 api 文档. 我已按照说明使用我的控制器和 DTO 构建文档 xml 文件，并且在本地运行良好. 但是，在生成 swagger 文档时，会抛出 500 错误.我已经确认如果我删除我的 xml 注册行，就会生成并成功返回 swagger 文档. 这是我的注册行: GlobalConfiguration
..
Swagger UI 显示，但我得到一个“错误"；指标
..
Swagger:支持可选路线
我有一个带有可选参数的路由: [Route("{categoryId?}")]公共 HttpResponseMessage 获取(int?categoryId=null) 但是，当我没有为 categoryId 提供值时，调用会在请求本身中包含 {categoryId?}... http://myhost/api/%7BcategoryId%7D 解决方案 Swagger 不支持可选路
..
Springfox swagger - 没有带有 spring boot jersey 和 gradle 的 api-docs
我有一个带有 jersey 和 gradle 的 spring boot 应用程序，我正在尝试使用 springfox 自动生成 API 文档. 我已按照此处的步骤操作:http://springfox.github.io/springfox/文档/当前/ 这是我所做的: build.gradle: 依赖项{…………//昂首阔步编译“io.springfox:springfox
..
从 Swagger Editor 发出请求时，如何避免 CORS 错误(“无法获取"或“未找到服务器或发生错误")?
我有以下 OpenAPI 定义: swagger: "2.0"信息:版本:1.0.0标题:简单的 API描述:学习如何编写 OpenAPI 规范的简单 API方案:- https主办方:now.httpbin.org路径:/:得到:摘要:以 rfc2822 格式获取日期回复:200:架构:类型:对象项目:特性:现在:类型:对象RFC2822:类型:字符串 我想从 响应中检索 rfc2822:
..
Autorest 错误 - swagger.json' 不是有效的 OpenAPI 2.0 定义(预期为 'swagger: 2.0')
我的 api 正在运行带有 Swashbuckle.AspNetCore 5.0.0-rc5 的 net core 3.0 当我在生成的 swagger.json 文件上运行 autorest 时，我得到: swagger.json 不是有效的 OpenAPI 2.0 定义(预期为 'swagger: 2.0') 我的 swagger.json 文件确实说“openapi":“3.0.1
..
swagger 在线编辑器可以通过地址栏输入一个 YAML url 作为输入吗?
我想访问 https://editor.swagger.io/ 但需要 YAML 文件基于 URL 参数预加载. 所以如果我想查看 https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore.yaml，我应该可以将其作为输入提供给可通过 Internet 访问的 swagger 编辑器.p>
..
如何配置“HTTPS"?带有 drf-yasg 自动生成的招摇页面的方案?
..
使用 Spring Boot 配置 Swagger 时出现意外结果
我对 Swagger 非常陌生，我开始记录使用 Spring Boot 构建的非常简单的 Web 服务. 问题是，在我配置 swagger 之后，当我在浏览器中键入 localhost:8080/swagger-ui.html 时，我会看到以下屏幕，并带有一些奇怪的弹出消息，上面写着“无法推断"基本 url.这在使用动态 servlet 注册或 API 位于 API 网关后面时很常见. 我
..
JSON-RPC Swagger 组合
我正在考虑使用 这个库 为我的 Web 服务实现 JSON-RPC.我还想为我的服务实现 Swagger. 但是，我不确定这两者是否是一个很好的组合.在 JSON-RPC 中，所有方法都位于同一资源后面，而在 Swagger 中则没有任何意义. 我想知道以下几点: 能否将这些技术充分结合起来? JSON-RPC 仍然是一种很好的技术吗?还是手动实现更好? 感谢您的想法.
..
如何在 OpenAPI 2.0 中为同一操作定义 path 和 formData 参数?
我有一个类似于 /test/{id}/relationships/image 的图像上传端点.我想使用 OpenAPI 2.0 (Swagger 2.0) 来描述这个端点. 端点同时具有 path 和 formData 参数.我尝试了以下方法: swagger: '2.0'信息:标题:API版本:1.0.0主机:api.server.de方案:- https产生:- 应用程序/json路径
..
如何将自定义模型绑定器与 Swashbuckle、Swagger 和 NSwag 一起使用?
我有一个包含以下端点的 ASP.NET Core Web API. [HttpGet][路线(“模型/{ids}")][产生(typeof(IEnumerable))]公共 IActionResult 获取([ModelBinder(typeof(CsvModelBinder))] IEnumerable身份证){//获取模型返回确定(模型)；}
..
如何在招摇中传递多值查询参数
我在 swagger.yml 中有以下服务.编写服务以便 page_id 可以多次传递.例如 /pages?page_id[]=123&page_id[]=542 我检查了此链接 https://swagger.io/specification/ 但不明白如何更新yml 所以我可以多次传递 id. 我看到我必须设置 collectionFormat 但不知道如何设置. 我尝试像下
..
如何在 OpenAPI (Swagger) 中将 $ref 属性声明为只读?
我正在尝试在此示例中为“House"添加一个只读字段.房子是另一个我想只读的模型. 在此示例中，Dogs 数组可以设置为 readOnly 而不会出错，但是当我将 House 的单个定义设置为 readOnly 时，我收到以下警告在 Swagger 编辑器中: 同级值不允许与 $refs 一起使用 我知道这是因为模型中的所有内容都在这里继承.那么如何定义 write API 调用
..
Django Rest Framework:如何为基于函数的视图启用 swagger 文档
..
如何将 @ApiModelProperty dataType 设置为 String 以获取 Swagger 文档
我正在使用 Spring MVC(通过 Spring Boot)并使用 swagger-spring-mvc 库集成了 Swagger API 文档. 我有一个看起来像这样的类: @ApiModel公共类 CartItem {...私人货币清单价格；//joda 金钱类@JsonSerialize(使用 = ToStringSerializer.class)@ApiModelPropert
..
如何为 OpenAPI 3.0.0 运行 swagger-codegen
看起来像官方 swagger for openapi 规范 V3 支持即将发布 https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/，并且 swagger-codegen 已经开发了 3.0.0 支持并通过了一定程度的测试 3.0.0 分支上的 rel="noreferrer">https://github.com/swagg
..