当前位置: 首页 > 知识库问答 >
问题:

Spring启动执行器上的昂首阔步

单于奕
2023-03-14

我正在用Swagger记录我的API,并将以下注释应用于我的所有REST控制器:

@Api(value = "Some value", description = "Some Description", tags = {"Tag Tag Tag"})

然而,我还想将Spring Boot Actuator(/health,/info)提供的endpoint包含在Swagger上(它们也包括在内),但是我似乎找不到一种方法来更改它们的默认描述、标记和标题以及其他Swagger属性。

有没有办法做到这一点?提前谢谢。

共有1个答案

杨成礼
2023-03-14

你可能需要重新考虑一下。由于暴露这些endpoint会造成明显的安全问题,因此故意隐藏这些endpoint。公布有关它们的详细信息不是一个好主意。

如果确实需要这样做,则需要添加构建的特定执行器控制器类。

就像这样。

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .paths(PathSelectors.any())
            .apis(RequestHandlerSelectors.basePackage("com.your.package.controller"))
            .apis(RequestHandlerSelectors.basePackage("org.springframework.boot.actuate"))
            .build().apiInfo(apiInfo());
}
 类似资料:
  • 问题内容: 我想知道如何用昂扬的方式记录枚举。 根据JavaDoc 数据类型。请参阅文档以获取受支持的数据类型。如果数据类型是自定义对象,请设置其名称,或不设置任何名称。如果是枚举,请为枚举常量使用’string’和allowableValues。 但是我没有找到一些好的Java示例如何真正使用它,规范在这里。 第一服务 第二服务 输入项 天 输出量 pom.xml 您可以在此处查看结果。 我看到

  • 数据类型。有关支持的数据类型,请参见文档。如果数据类型是自定义对象,请设置它的名称,或者不设置任何名称。对于枚举,使用'string'和allowableValues作为枚举常量。 但是我没有找到一些好的Java示例如何真正使用它,规范在这里。 你可以在这里看到结果。 我认为是个问题... 你知道吗?

  • 我们正在为我们的Laravel REST API实现开发Swagger文档。几个POSTendpoint将使用CSV作为参数内容类型。 Swagger中是否有一种方法可以让“立即尝试”功能与CSV POST文件上传一起使用? 下面是我们的留档http://api.curvecompass.com/docs/#/ 我们的Laravel POST函数可以正确地与CSVendpoint一起工作,而不是与

  • 我有一个Spring启动项目,其中我集成了swagger,用于API文档。 现在的问题是默认情况下它显示模型部分,这是一个安全问题。我试过了,但无法隐藏它。也在这里通过了这个链接如何在Swagger UI中隐藏模型部分? 但在这方面,他们也引用了一些索引.html文件,但我只有后端,没有前端。那么如何实现同样的目标,请帮忙。 谢谢

  • 问题内容: 我正在尝试使用swagger定义post端点,但是不允许使用该参数: 当我跑步时,我得到这个: 我的规格有什么问题? 问题答案: 您可能正在混合使用OpenAPI / Swagger 2.0和OpenAPI 3.0语法。您的规格似乎是2.0,但是关键字是3.0功能。在2.0中,请求正文被定义为正文参数: 更多信息:描述请求正文

  • 这不是springfox的故事,这是springdoc-openapi的故事。 我当前的依赖项 我的物业 此处请求(localhost:8080/swagger-ui.html)我的服务器响应swagger-petstore示例我已经知道petstore-disable(springdoc.swagger-ui.disable-swagger-default-url=true),但它不起作用 另一