openapi相关内容

在Swagger Open API 3.0中使用另一个参数时,如何指示一个参数是有条件的必填参数

我已经创建了一个REST风格的API,现在我正在定义Open API 3.0 JSON表示以使用此API。 当存在另一个参数时,我要求有条件地使用参数。所以我不能真正使用required: true或required: false,因为它需要是有条件的。我是否应该将其定义为required: false,然后在summary和/或description中说明在使用其他参数时它是必需的?或者有 ..
发布时间:2022-05-24 13:32:56 其他开发

Swagger OpenApi Spec 3.0-删除操作

我正在使用swagger Openapi规范3.0从我的界面生成swagger。我有一个Delete方法,它接受请求正文。但根据RFC7231,Delete不接受任何请求Body。Swagger-request body也是如此。但是我的API被设计成在删除操作中接受请求正文。在创建swagger以使删除操作接受请求正文时有什么解决方法吗?目前,我从Savagger生成中得到的错误是什么? ..
发布时间:2022-05-24 13:08:45 其他开发

使用OpenAPI Maven插件生成API文档

我正在尝试为从OpenAPI 3 YAML生成的Spring REST应用程序生成API文档终结点(例如/v3/api-docs)。 我注意到Maven plugin有一个generateApiDocumentation标志 我不太确定它是做什么的。 遗憾的是,SpringFox还不支持OpenAPI 3--而且,当我只想将初始的YAML公开为json时,使用基于反射的生成器似乎毫无意义。 ..
发布时间:2022-05-24 12:50:54 其他开发

更改Spring Openapi-Generator-maven-plugin生成的接口的返回类型

我已经设法从.yaml开放API描述符文件生成了接口,但是,正如问题标题中所述,我希望将这些接口的响应类型从ResponseEntity更改为我自己的类型。基本上不是具有以下签名的接口: ResponseEntity clearCache(); 对于基本上是这样实现的方法: public void clearCache(){ //do something} 我希望 ..
发布时间:2022-05-24 12:46:31 Java开发

服务器响应不显示&Quot;请求持续时间&Quot;

我正在使用Openapi 3.0.0。一切都运行得很好。例.正在生成cURL、显示的响应正文、响应标头。 但在服务器响应下未显示“请求持续时间” 参考附件 推荐答案 您必须在swaggerOptions中添加displayRequestDuration: true, displayRequestDuration:默认情况下boolean=False。控制“试用”请求的 ..
发布时间:2022-04-16 20:25:28 其他开发

构建OpenAPI响应,包括其中之一,也可能包括Allof

我正在尝试使用OpenAPI 3从各种架构组件构建响应。响应基本上分为三个部分: 其他终结点使用的共享组件(即成功/失败标志)。-#/components/schemas/core_response_schema内部allOf。 此终结点上的所有响应使用的属性(即user_id)-以下的properties组件。 根据用户类型的不同而不同的几个架构之一。-oneOf组件。 我已经确 ..
发布时间:2022-04-16 20:22:31 其他开发