swagger-2.0相关内容
我使用的是swagger 2.0,我有一个终结点,它使用表单数据作为请求的有效负载,我在几个地方使用相同的表单数据主体请求,我不想一次又一次地编写它(复制它),我不知道如何在我的YAML文件中对其建模(当对象作为请求主体的一部分作为有效负载时,我知道如何对其建模)。 这是我尝试建模的表单数据有效负载: 我查看了Swagger的文档:https://swagger.io/docs/spe
..
我试着遵循这些: https://www.dariawan.com/tutorials/spring/documenting-spring-boot-rest-api-springdoc-openapi-3/ 如何处理如下批注: @ApiModel(value = "Response container") @ApiModelProperty(value = "Iventory
..
我有一个使用Spring Boot构建的rest API项目,我想记录我的所有端点。我已经实现了Swagger,并且成功了,但最近我的项目不再运行,配置与创建项目和Swagger工作时相同。 尝试运行项目时出现此错误: WARN 17868 --- [ restartedMain] ConfigServletWebServerApplicationContext : Exceptio
..
默认情况下,swagger将access_code传递给标头。是否可以通过id_token? 我正在用swagger.yaml版本记录我的NodeJS睡觉接口2.0 推荐答案 是,这是可能的,尽管这不是一个好主意,因为mentioned by @DalmTo。 您需要将x-tokenName: id_token添加到API定义中的Google OAuth安全定义。 s
..
如何通过以下GitHub(https://github.com/jensoleg/swagger-ui)使用Json编辑器? 要为请求正文启用JSON编辑器,需要使用哪些代码? 尝试更改我的代码,但对我无效。如有任何帮助,我们将不胜感激。 Swagger UI 3.x和4.x不支持推荐答案 JSON表单编辑器。有一个existing feature request。
..
我想在我的 api 文档中用 2 位表示小数,用 1 位表示小数.我正在使用 swagger 2.0,规范中是否有内置定义类型或任何其他“圆形"参数,或者我唯一的选择是使用“x-"扩展名? 解决方案 OpenAPI (fka Swagger) 规范使用 JSON Schema 来描述数据类型. 如果参数作为数字传递,您可以尝试使用 this Q& 中建议的 multipleOf一个:
..
我的 swagger.yaml 中有这样的架构对象定义: 用户:类型:对象特性:用户名:类型:字符串描述:用户名颜色:类型:数组项目: {类型:字符串,枚举:[“红色"、“蓝色"、“绿色"]}描述:用户必须关联一种或多种颜色必需的:- 用户名- 颜色 但是,生成的服务器仍然很乐意接受使用此架构对象作为不包含任何 colors 字段的必需主体参数的 POST 请求. 我能否以 color
..
我正在尝试通过使用 allOf 来找出这种招摇的 API 继承的东西.这是我招摇的 yaml 文件. 招摇:'2.0'信息:标题:测试API版本:'1'基本路径:/api/v1方案:- https产生:- 应用程序/json路径:/用户:得到:摘要:用户集合标签:- 用户回复:200:描述:用户列表架构:$ref:“#/定义/用户"500:$ref: "#/responses/BadReques
..
我正在使用 swagger 在 Java 和 Type 脚本中生成类.我在使用对象列表作为值定义地图属性时遇到问题.我尝试定义如下: DataMap类型:对象附加属性:#type: array -- 这个配置不起作用.$ref: '#/定义/数据' 上面的yml定义在java中生成如下代码: 类 DataMap 扩展 HashMap;{} 如何配置 yml 以生成带有数据列表的密钥?类似
..
我已经学习了一些教程,并且已经让它在工作中工作,但由于某种原因,我无法让 UI 显示,但创建了 Swagger Json.我看的最后一个教程是 这里. 我的设置是这样的: Nuget 包: Swashbuckle.AspNetCore(1.0.0) ConfigureServices 方法: services.AddSwaggerGen(options =>{options.S
..
如何使用 Swagger 2.0 注释定义基本身份验证并将其显示在 Swagger UI 中. 在我拥有的资源中: @ApiOperation(value = "返回类别列表", response=Category.class, responseContainer="List", httpMethod="GET", authorizations = {@Authorization(valu
..
我在我的 Spring Boot 应用程序中使用 Springfox Swagger2 2.4.0 版、Springfox Swagger UI 2.4.0 版和 Swagger Annotations 1.5.0 版. 这里的问题是,我能够为我的控制器的 API 生成 swagger UI,并且我能够对其进行测试.但我无法为我的请求标头指定请求标头描述.我正在使用 @RequestHead
..
我迁移到最新的 springfox-swagger2 版本 2.10.0 但看起来 @EnableSwagger2 已弃用. 为了将 Swagger 启用到 Spring Boot 项目中,我应该使用什么注释?@EnableSwagger2WebMvc? 解决方案 @EnableSwagger2 在 swagger 2.10+ 中被弃用 @EnableSwagger2WebMv
..
..
我正在使用 RestTemplate 调用 AutoTask API.但是,我收到一条错误消息: 500 Internal Server Error: [{"errors":[""Unexpected character met while paring value: %.路径 '',第 0 行,位置 0."]}] API 调用的 Swagger UI 截图(成功) 控制台输出(错误)
..
我有一个带有可选参数的路由: [Route("{categoryId?}")]公共 HttpResponseMessage 获取(int?categoryId=null) 但是,当我没有为 categoryId 提供值时,调用会在请求本身中包含 {categoryId?}... http://myhost/api/%7BcategoryId%7D 解决方案 Swagger 不支持可选路
..
我有一个类似于 /test/{id}/relationships/image 的图像上传端点.我想使用 OpenAPI 2.0 (Swagger 2.0) 来描述这个端点. 端点同时具有 path 和 formData 参数.我尝试了以下方法: swagger: '2.0'信息:标题:API版本:1.0.0主机:api.server.de方案:- https产生:- 应用程序/json路径
..
我正在尝试在此示例中为“House"添加一个只读字段.房子是另一个我想只读的模型. 在此示例中,Dogs 数组可以设置为 readOnly 而不会出错,但是当我将 House 的单个定义设置为 readOnly 时,我收到以下警告在 Swagger 编辑器中: 同级值不允许与 $refs 一起使用 我知道这是因为模型中的所有内容都在这里继承.那么如何定义 write API 调用
..
我正在使用带有 node.js express 4.12.3 和 mysql db 的 swagger 2.0. 我创建了以下架构 - 国家:类型:“对象"特性:ID:类型:“整数"只读:真描述:“国家 ID"国家:类型:“字符串"描述:“国家名称"created_at:类型:“字符串"只读:真格式:“日期时间"描述:“国家记录创建日期"已删除_at:类型:“字符串"格式:“日期时间"描
..
在我的 API 文档中,我想为每个 API 端点定义必要的安全性.该项目已定义角色和权限,以确定哪些用户可以访问 API.Swagger 中记录此信息的最佳方式是什么?是否有关于如何显示此详细信息的最佳做法或建议? 这是我尝试使用 securityDefinitions 和角色的自定义变量,但是当我通过 swagger2markup 或使用 swagger-ui 运行它时,该信息(x-rol
..