问题标签 [springdoc-openapi-ui]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
swagger-ui - Swagger UI 中的掩码输入(示例 - 密码)?
我有一个 API 的三个路径变量。我想用 ***** 屏蔽 Swagger UI 上的一个输入。
使用 Springdoc OpenAPI 时如何执行此操作?
java - 如何自定义请求正文的示例值并使用 springdoc-open-api 在 swagger-ui 上执行它
我已经使用springboot创建了rest webservice并添加了springdoc-open-api用于webservice的文档化,现在我有2个问题
1-如何在 swagger-ui 文档页面上显示的请求中添加自定义测试值?
2-如何在 swagger-ui 文档页面上单击 TRY IT OUT 按钮执行请求?
请参阅下面的代码片段以了解 REST Web 服务:
springdoc-openapi-ui - springdoc openapi UI无响应,当API返回大响应时
我们最近从 springfox 迁移到 springdoc openapi 3。其中一个 API 返回大约 2MB 的数据,它在 springfox 中正常工作,但 springdoc openapi UI 几分钟没有响应,渲染也需要超过 2 分钟。有什么办法可以解决吗?
spring - 如何使用 Spring OpenAPI 3.0 忽略 Swagger 请求字段?
我们有以下Token模式,而 scmOrg 被定义为外键。
打开 Swagger 控制台时,它会像这样构建示例输入:
只能为现有的scmOrg实体添加新令牌,所以我真正想要的是像这样更严格的东西:
Swagger 可以吗?
swagger - Swagger OpenApi 动态查询参数名称使用 Spring 自定义解析器的注释
我试图弄清楚如何指示SpringDoc
OpenApi
正在生成一个自定义对象,使用HandlerMethodArgumentResolver
它拦截一些传入的请求参数并从中创建一个对象。这个概念实际上与 Spring 对@Pageable
.
这是我的自定义对象的一部分:
FlightRequest
班级:
FlightRequest
使用默认查询参数名称的控制器:
FlightRequest
与自定义查询参数名称一起使用的控制器:
就像您在上面的示例中看到的那样,每个端点都可以覆盖默认查询参数名称。
我怎样才能表明这一点Spring Doc
?
spring-boot - 如何在springdoc中注释要求requestBody的各个元素?
我有一个弹簧(引导)服务器,并想从带有 springdoc 的注释中生成 openapi 规范。
我在请求正文中有一个带有两个参数的请求。我希望第一个是必需的,第二个是可选的
@RequestBody(required = {true|false})
似乎只将正文中的所有参数设置为(不是)必需的。@Parameter
另一方面,Javadoc说要使用io.swagger.v3.oas.annotations.parameters.RequestBody
这是我的代码,我希望生成一个规范,其中第一个参数是必需的,第二个是可选的:
然而,生成的规范需要两个参数:
我怎样才能只要求所有四种请求类型的特定参数?
springdoc - Swagger 2 Springfox useDefaultResponseMessages() 方法的 Springdoc 等效项是什么?
我们正在从 Springfox 迁移到 Springdoc,并想知道 Springdoc 是否具有 useDefaultResponseMessages() 等价物?
已经看到一些需要一些编码的解决方案,但我想知道是否有一些可以像 useDefaultResponseMessages() 一样简单地实现的东西
在 springfox 中创建默认文档时,添加起来非常简单。
springdoc-openapi-ui - 无法在端口 9001 连接到 MBean 服务器:无法调用关闭操作:
在 mvn clean install 上出现错误,尝试为 openAPI 规范生成 openapi.json
[错误] 无法在项目 abcd 上执行目标 org.springframework.boot:spring-boot-maven-plugin:2.3.0.RELEASE:start (pre-integration-test):无法确定应用程序是否已启动:无法在端口 9001 连接到 MBean 服务器:无法调用关闭操作:Spring 应用程序在配置的超时之前没有启动(30000ms -> [Help 1] [ERROR] [ERROR] 要查看错误的完整堆栈跟踪,请重新- 使用 -e 开关运行 Maven。[错误] 使用 -X 开关重新运行 Maven 以启用完整的调试日志。[错误] [错误] 有关错误和可能解决方案的更多信息,请阅读以下文章:[错误] [帮助 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
使用以下配置 -
spring-boot - 如何使用 OpenApi 自定义 swagger-ui.html url
正如标题所示,有没有办法改变类型的招摇网址
localhost:8080/myapp/swagger.ui.html
进入一个网址
我使用 OpenApi3,到目前为止,在文档中我不知道如何更改“swagger-ui”。感谢您提供任何可能的答案