swagger-2.0相关内容
我正在使用带有node.js express 4.12.3和mysql db的swagger 2.0. 我创建了以下架构- Country: type: "object" properties: id: type: "integer" readOnly: true description: "Country
..
我正在使用Swagger编辑器编写API文档,但是包含JSON对象的多部分POST请求有问题.这是我的Swagger YAML文件: swagger: '2.0' info: version: 1.0.0 title: Documentation API paths: /agent: post: consumes: - multipart/form
..
我正在处理一个摇摇欲坠的文件,其中查询参数不能接受任何值或n个值.我该如何在Swagger Yaml中写这个? 我提供的网址:/sort=field1,field2 在swagger文件中声明的参数 - name: sort in: query schema: type: string enum: [field1,field2,field3] allo
..
我有一个使用以下JSON请求正文的POST请求.如何使用OpenAPI(Swagger)描述此请求正文? { "testapi": { "testapiContext": { "messageId": "kkkk8", "messageDateTime": "2014-08-17T14:07:30+0530"
..
由于一些向后兼容的原因,我需要同时支持路径/ab和/a-b. 两个路径的请求和响应对象都将相同. 我的Swagger规范中可以包含以下内容吗,这样我就不必为两个路径都重复请求和响应对象的定义了. paths: /ab: /a-b: post: ... 解决方案 是的,您可以让一个路径项引用另一个路径项,如下所示: paths: /ab:
..
引用 OpenAPI 2.0,架构对象或 Swagger 2.0,架构对象,discriminator字段的定义为: 增加了对多态性的支持.区分符是架构属性名称,用于在继承该架构的其他架构之间进行区分.必须在此模式下定义使用的属性名称,并且该属性名称必须在required属性列表中.使用时,值必须是此架构或继承该架构的任何架构的名称. 我的困惑/问题: 这对我来说是模棱两可的,它
..
Swagger/OpenAPI 2.0中的Schema对象是否必须具有type属性? 一方面,根据JSON Schema Draft 4规范,未指定type属性为OK,这意味着该实例可以是任何类型(对象,数组或基元). 另一方面,我已经看到很多Swagger模式,这些模式包含的Schema对象没有type属性,但是具有properties属性,这清楚地表明模式作者希望实例是一个实例.适
..
有人知道如何在OpenAPI 2.0定义中定义可能的“枚举"值,以便将其显示在Swagger UI的“模型"选项卡中吗?此处的示例: https://petstore.swagger.io/#!/pet/addPet为status属性具有一个枚举选项.如何在OpenAPI 2.0中定义这样的枚举? 解决方案 “枚举"的工作原理如下: { "in": "qu
..
比方说,我有一个像limit这样的参数.这个地方到处都是,如果要更新它,到处都必须更改它是一个痛苦的事情: parameters: - name: limit in: query description: Limits the number of returned results required: false type: number
..
我知道有一种工具可以进行在线验证: http://online. swagger.io/validator?url=http://petstore.swagger.io/v2/swagger.json 我正在编写一个JUnit测试,以验证项目的swagger.json文件.重要的是,此验证可以离线完成,因为该测试以localhost运行,并且该验证工具无法访问本地主机服务器. 那
..
我正在查看以下教程:我很好奇,是否以某种方式在swagger ui中提供了支持以显示查询参数. 基本上,我希望所有带有[EnableQueryAttribute]属性标记的调用都具有用于输入查询参数的大写ui,并且我不想将这些参数添加到方法调用中,但我仍然希望它们位于URL中并拉出以用于奥文语境. 有什么建议吗? 解决方案 答案比我想象的要容易得多.我最终要做的是创建一个IOp
..
我正在尝试通过Swagger UI为公司内部使用记录在供应商产品(WSO2 ESB)中开发的现有API服务.供应商产品不支持摇摇欲坠.我计划以编程方式检查/处理我的API服务的源代码(用卖方产品编写),并生成.json或.yml格式的swagger定义文件的目录/文件夹/库.很好,我可以做到. 每个这些api定义文件都可以在swagger UI中很好地呈现,我正在使用 https: //ww
..
我在Swagger文件中有一个API参考.我想创建一个非常简单的模拟服务器,以便在调用例如: mymockurl.com/users,它将返回预定义的JSON(无需连接到数据库). 最简单的方法是什么?我不是后端人. 解决方案 SwaggerHub 提供了模拟服务器,用于OpenAPI 2.0和3.0规范.免费计划和付费计划都支持模拟. 要使用模拟服务器,请将您的规范导入
..
我有一个DTO,其中包含Java 8 LocalDate类型的字段.使用Jackson批注,可以将format设置为ISO.DATE,并且一切正常.但是Swagger(我的版本为2. +)将LocalDate.class作为对象 LocalDate { month (integer, optional), year (integer, optional) } (是的,但是...)我想把它
..
如何在swagger编辑器中指定3列,这样输出应如下所示: a b c x y z swagger: '2.0' info: description: > This is a sample server Petstore server. [Learn about
..
我想格式化Swagger API描述的格式,以便它们不是简单的文本段落.最好是,我想在上面添加一张小桌子. 我没有在Swagger描述中找到有关文本格式的在线参考.如果启动 Swagger编辑器,然后打开Instagram示例(文件\打开示例\ Instagram.yaml) ,我看到yaml文件中的第一个说明显示了一些格式,包括超链接和边框: [registered your
..
试图用昂首阔步的定义使这个Json脱颖而出: { "attachments":[{ "attachment": { "filename": "string", "filedata": "string", "filetype": "string" } }, { "attachment": { "filename": "string", "
..
我在使用API文档时使用 Swagger-ui 来获取所需的api文档在每个响应中添加任何名称的新列, "responses" : { "400" : { "description" : "Invalid ID Supplied" }, "404" : { "descr
..
我有一些问题要解决, 根据下面的链接,请求正文的JSON编辑器(默认情况下处于禁用状态). https://github.com/jensoleg/swagger-ui 如何启用它? 解决方案 我找到了解决方案.将以下内容添加到new SwaggerUi({})构造函数中的index.html中: docExpansion: "none", sorter: "alpha"
..
我想从招摇定义文件(yaml/json)生成示例请求和响应.目的是存根这些API. 很不幸,我没有管理员权限来安装swagger编辑器的generate server列表中列出的任何服务器框架.我还尝试了用soapui(5.x)和ready api模拟它,但是它们都无法解析定义文件的响应对象中的架构引用- 例如: "responses": { "200": {
..