82得票2回答
Swagger; 基于可选参数指定两个具有相同代码的响应

这个问题不是 (Swagger - Specify Optional Object Property or Multiple Responses) 的重复,因为那个 OP 尝试返回 200 或 400. 我有一个带有可选参数的 GET,例如: GET /endpoint?selector=f...

78得票7回答
API注解的描述已经过时。

在 Swagger 中,@Api 注释中的 description 元素已被弃用。 弃用。 在 1.5.X 中不再使用,仅保留以支持旧版本。 是否有一种新的方式来提供说明?

78得票7回答
如何在Swagger中描述一个包含简单对象的数组模型?

我有一个需要记录的REST服务,其中一些接受简单的数组,例如: [ { "name":"a" }, { "name":"b" }, { "name":"c" } ] 我该如何在Swagger模型部分描述这个问题?我只能创建像“命名数组”一样的东西 model { prope...

65得票9回答
在SpringFox SwaggerUI中删除基本错误控制器。

有没有办法从Springfox Swagger-UI中删除"basic-error-controller"? 图片:

63得票2回答
从Springfox Swagger 2迁移到Springdoc Open API

我试图遵循以下内容: https://www.dariawan.com/tutorials/spring/documenting-spring-boot-rest-api-springdoc-openapi-3/ 我如何处理像这样的注释: @ApiModel(value = "响应...

63得票6回答
Swagger编辑器显示路径参数的“模式错误:不应有附加属性”错误

我正在使用http://editor.swagger.io设计API,但是遇到了一个错误,我不知道如何解决: Schema error at paths['/employees/{employeeId}/roles'].get.parameters[0] should NOT have ad...

52得票5回答
在Swagger API中将字符串数组指定为请求体参数。

我想发布一个字符串数组,例如[ "id1", "id2" ] 转向基于Swagger的API。在我的Swagger文件中,我有这些行:paths: /some_url: post: parameters: - name: ids ...

51得票3回答
如何在OpenAPI(Swagger)中描述此POST JSON请求体?

我有一个使用以下JSON请求正文的POST请求。我如何使用OpenAPI(Swagger)描述此请求正文?{ "testapi":{ "testapiContext":{ "messageId":"k...

47得票4回答
如何使用Swagger指定属性可以为null或引用

如何在swagger中指定属性为空或引用?讨论了如何使用Jsonschema来指定属性为空或引用。 我正在寻找在swagger中实现相同的功能。 为了概括上述答案,在jsonschema中,可以像这样做:{ "definitions": { "F...

47得票6回答
如何生成swagger.json文件

我正在使用Java Spring Boot框架创建REST API,使用"springfox-swagger2和springfox-swagger-ui"生成Swagger文档。 我可以通过网址http://localhost:8080/swagger-ui.html查看我的文档。 如何创建...