swagger-2.0相关内容

如何重用swagger定义并删除其中的一些参数?

这是我的代码: 定义:用户:类型:对象特性:ID:类型:整数用户名:类型:字符串名:类型:字符串姓:类型:字符串密码:类型:字符串created_at:类型:字符串格式:日期时间更新时间:类型:字符串格式:日期时间必需的:- 用户名- 名- 姓- 密码/api/用户:邮政:描述:添加一个新用户操作 ID:存储参数:- 姓名:用户描述:用户对象在:身体要求:真实类型:字符串架构:$ref: '#/ ..
发布时间:2021-11-15 01:38:45 其他开发

OpenAPI:接受任何(复杂)JSON 值的模式

我为其编写 Swagger 2.0 规范的 API 基本上是任何 JSON 值的存储. 我想要一个读取值的路径和一个存储任何非预定义深度的 JSON 值(空值、数字、整数、字符串、对象、数组)的路径. 不幸的是,Swagger 2.0 似乎对输入和输出的模式非常严格,并且不允许使用 JSON 模式允许的整个模式集.Swagger 编辑器不允许例如混合值(例如可以是布尔值或整数的属性)或 ..
发布时间:2021-11-15 00:19:24 其他开发

使用 Swagger 注释显示自定义 HashMap 键

我正在尝试从 Java 代码生成 Swagger 文档,我的嵌套模型属性之一是 HashMap.为它生成的示例如下: "additionalProp1": {“自定义对象":{}},“附加道具2":{“自定义对象":{}},“附加道具3":{“自定义对象":{}} 我需要它看起来像: "objectName": {“自定义对象":{}} 换句话说,我需要告诉他们 additionalP ..
发布时间:2021-11-10 23:15:48 Java开发

如何用实际示例替换模型架构主体参数

我有 spring-boot/spring-mvc 和 springfox swagger2 集成.我附上了示例屏幕截图.在“body"的参数类型中,我有一个描述元素数据类型的模型模式.字符串,0 等!如何用实际示例替换它,以便我可以“尝试一下".这对我的 API 消费者更有用. 解决方案 不确定你是否找到了这个问题的答案,但我还是会回答这个问题. @ApiModelProperty ..
发布时间:2021-09-01 20:22:18 其他开发

我可以从 json 文件创建存根 swagger 模型定义吗

是否有工具可以让我从示例 JSON 生成 Swagger yaml 定义模型? 我会进入并编辑和清理 yaml,但如果有什么东西可以基于大型或复杂的示例 json 对象来剔除 yaml 的结构,那就太好了. 解决方案 您可以使用具有此功能的 Apigee API Studio: http://apistudio.io/ 点击插入菜单,然后点击新建模型.形成一个 JSON ..
发布时间:2021-09-01 20:22:15 其他开发

Go API 在 html (Swagger UI) 中显示 swagger api 规范 (json)

我有一个服务于特定端口的应用程序(大猩猩/多路复用器).我也有一个 json 文件形式的 swagger API 规范.是否有任何 go API 可以像 Spring Boot 一样从 JSON 文件生成 swagger UI 定义.我在看 https://github.com/go-swagger/go-swagger,但我无法在我的 go-lang 代码中使用它.看来这个 API 只能从命令行 ..
发布时间:2021-09-01 20:22:10 其他开发

如何将对象数组定义为参数?

我对 Swagger 很陌生,所以这可能是一个基本问题. 我能够为一个以整数数组作为参数的 API 创建 .yml 文件,如下所示: 添加示例---标签:- 我的 API参数:- 名称:my_id在:路径类型:整数要求:真实描述:一些设计- 名称:身体在:身体架构:id:add_samples必需的:- sample_ids特性:样本 ID:类型:数组项目:类型:整数描述:要添加的示例 I ..
发布时间:2021-09-01 20:22:06 其他开发

如何忽略特定 http 动词(GET、POST、PUT)的 swagger 资源属性

我们实现了 2.6.1 版的 spring fox swagger 2,我想为 HTTP GET METHOD 而不是 POST METHOD 显示资源的特定属性,我还没有找到任何使用 swagger 2 的方法.请帮忙,谢谢. 例如: 班级员工{整数标识;字符串名称;} 请求 URI:GET/api/employee/{id}我应该看到 swagger 请求文档为 {ID:"",姓名 ..
发布时间:2021-09-01 20:22:03 其他开发

Swagger-ui 不会从示例正文中隐藏只读嵌套对象

我正在使用 swagger-ui 和 lombok 开发 spring-boot 应用程序.目前我正在尝试从请求正文中隐藏嵌套对象,但它仍然显示在 swagger-ui 页面上的示例 json 中. 我的课程带有注释(简化为仅相关内容): @Data@ApiModel(description = "角色模型")公共类字符{@ApiModelProperty(readOnly = true) ..
发布时间:2021-09-01 20:22:01 Java开发

控制器没有出现在 swagger-ui.html 中

我将 Swagger 2 与非 spring-boot 一起使用,我也可以在 Tomcat 上部署我的应用程序并成功运行它.但是控制器没有出现在 swagger-ui.html 中,只显示带有绿色 swagger 标题的空白页面.我在这个问题上花了两天时间.你能给我一些建议吗? @Controller 表示如下类: @Api@控制器@RequestMapping("/用户")公共类用户控 ..
发布时间:2021-09-01 20:21:57 其他开发

Swagger/Swashbuckle 列出可接受的值?

我已经在我的 Web API 应用程序上成功实现了 Swashbuckle/Swagger,但对输出并不满意. 我的一个 web api 方法(企业事件日志记录工具)接受复杂对象值的 JSON 对象. 问题在于,当存在可以使用的可接受值的选定列表时,参数会作为字符串对象列出.我已经设置了默认值,以便如果发送不正确的内容,我将设置为默认值. 我想我可以添加其他返回可接受值的服务调用 ..
发布时间:2021-09-01 20:21:55 其他开发

Swagger Schema 错误不应具有其他属性

我正在尝试创建 swagger json 并尝试检查它的有效性http://editor.swagger.io 验证json后,上面提到的编辑器给出以下错误: 架构错误不应该有额外的属性附加属性:组件跳到第 0 行 如果由于某种原因我无法在根级别定义名为 components 的元素,我将在其中拥有某种 json 架构,那么在 API 操作的 requestBody 架构上执行 $ref ..
发布时间:2021-09-01 20:21:52 其他开发

作为参数传递的 swagger 对象可以在 swagger-ui 中具有默认值吗?

我定义了一个以 MyObject 作为参数的路径.MyObject 具有猫和狗的属性.这些有默认值.在 swagger-editor 中,该示例未显示默认值,但试用确实创建了一个具有正确默认值的 MyObject. 在 swagger-ui 中,我可以在 Models 下看到默认值,但在 API 中看不到.有没有办法设置这些默认值?招摇:'2.0'信息:标题:将具有默认属性的对象作为参数传递 ..
发布时间:2021-09-01 20:21:43 其他开发

swagger ui 中的隐藏字段

我使用的是 swagger UI 2.0.23 版本,我使用 json 文件提供 api.我需要使用 swagger ui 向我的 api 发送一个特定的标头值,但该字段在 ui 中不应该可见.因为值不应该被改变.因此,如何隐藏该字段以使其不显示在 ui 中.我试过以下示例但没有用 {"name": "access_type","数据类型": "字符串",“枚举":[“高的"],“必需":“真 ..
发布时间:2021-09-01 20:21:38 其他开发

Swagger 2.x 过滤器未执行

我在 Jersey 2.34 Web 服务中使用 Swagger 2.x/OpenAPI 3.0 (io.swagger.v3.oas.*) 记录 API.我已扩展 io.swagger.v3.core.filter.SpecFilter 以实现操作(方法)的自定义过滤以显示在 API 文档中. import io.swagger.v3.core.filter.OpenAPISpecFilter ..
发布时间:2021-09-01 20:21:36 Java开发