32得票1回答
Swagger UI中的对象枚举?

我在我的Swagger规范中有一个其他定义的枚举:"action": { "title": "Action", "description": "Action to apply to matching requests", "type": "object", "enum": [ ...

32得票2回答
如何在Swagger中指定返回PDF文件?

我的Swagger REST API中有一个GET调用需要返回一个PDF文件。目前没有明确的例子/文档说明如何在不导致语法错误的情况下完成此操作。 responses: 200: description: Returns PDF schema: [applic...

30得票3回答
如何使定义中的某个字段对于某些操作是必需的,而对于其他操作则不是

我正在使用yaml编写我的swagger定义。假设我有一个看起来像这样的定义:paths: /payloads: post: summary: create a payload ... parameters: - in: body ...

27得票1回答
Swagger UI中的多级(嵌套)标记

最近我开始学习使用Swagger 2.0 API。我正在寻找一些方法来组织API文档。目前我正在使用@Api(tags = {"Heading1"}) Java注解为每个API打标签。生成的文档看起来像这样:Tasks --------->Heading1 ...

26得票5回答
Swagger ApiModelProperty access

我正在REST端点中同时使用相同的对象来处理请求和响应。 是否可以用ApiModelProperty(access = "response")对属性进行注释 然后用@ApiImplicitParam(access = "response")对REST端点方法进行注释, 使得该属性仅在Swagg...

26得票7回答
避免Swagger API中的默认basic-error-controller

我在我的Spring Boot项目中使用swagger2。它运作良好,但我需要从API中排除basic-error-controller。目前我正在使用以下带有正则表达式的代码。它能够工作,但是否存在更完美的方法来实现这一点。 CODE:@Bean public Docket demoApi...

26得票2回答
多态中的“鉴别器”,OpenAPI 2.0(Swagger 2.0)

参考OpenAPI 2.0,模式对象或Swagger 2.0,模式对象的定义,以及定义discriminator字段: 为多态性提供支持。鉴别器是用于区分继承此模式的其他模式的模式属性名称。所使用的属性名称必须在此模式中定义,并且必须在required属性列表中。使用时,值必须是此模式...

26得票5回答
使用Swashbuckle来为Asp.net core生成API文档,如何将一个模型添加到生成的模型列表中?

我正在使用ASP.net core的Swashbuckle。它生成了一个漂亮的网站,在底部有一个模型列表。 我该如何将尚未出现在列表中的模型添加到其中? 在我的某个请求中,我返回了一个抽象类,并且我想列出所有继承该抽象类的变体。 提前致谢。

26得票2回答
如何在SwaggerHub中返回对象数组?

我正在使用 OpenAPI 2.0 在 SwaggerHub 中定义 API 规范。 /contacts 请求返回一个联系人数组。 定义如下: /contacts: get: tags: - contacts summary: Get...

26得票1回答
Swagger 2是否可以默认进入试用模式?

我正在使用Springfox的Swagger 2。 当您单击一个终端节点时,是否有办法默认启用“尝试”模式,而无需单击此按钮: