【问题标题】:How can I modify swagger-ui.html for springfox?如何为 springfox 修改 swagger-ui.html?
【发布时间】:2016-07-09 23:49:53
【问题描述】:

我正在使用 springfox 的招摇实现。我想修改 swagger-ui.html 以采用自定义标头值。如何修改此文件?还是告诉 spring fox 使用备用文件?

【问题讨论】:

  • 我能够按照这里的说明来实现这一点:github.com/springfox/springfox/issues/1176 基本上,您可以下载源代码并进行任何您需要进行的修改。您不需要创建 web jar。只需将其复制到您的资源中并让您的应用使用资源处理程序处理它

标签: springfox


【解决方案1】:
  1. 从 github 拉取 Swagger UI。

    https://github.com/swagger-api/swagger-ui

  2. 将swagger ui的dist目录复制粘贴到resources目录

  3. 在 swagger 配置中将代码替换为以下代码

    替换

    registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
    

    registry.addResourceHandler("**").addResourceLocations("classpath:/dist/");
    
  4. 将 index.html 中的 api 文档路径更改为您的路径

    替换

    http://petstore.swagger.io/v2/swagger.json
    

    http://localhost:8080/your_app/v2/api-docs
    
  5. 使用下面的 url 模式查看 ui 页面

    http://localhost:8080/your_app/index.html

【讨论】:

  • 谢谢,这行得通,但深度链接不起作用(我在大摇大摆地向特定打开的端点发送链接时出错)。知道如何解决吗?谢谢!
  • 现在更新:在第 1 步中。 3、行"registry.addResourceHandler("").addResourceLocations("classpath:/dist/");"不起作用,因为现在 SpringBoot 具有 /static、/resources 的默认映射。 /META-INF/资源。因此,/dist 映射不起作用。此外,“”标志也是无效的,您必须提供有效的 html 页面名称。谢谢
【解决方案2】:

是的,将 swagger ui 拉入您的项目并按照此处的步骤操作: https://github.com/springfox/springfox/issues/1176

然后编辑 index.html 并将它指向 petstore 的位置更改为您的端点。 (即“http://localhost:8080/MyProjectName/v2/api-docs”);

 $(function () {
  var url = window.location.search.match(/url=([^&]+)/);
  if (url && url.length > 1) {
    url = decodeURIComponent(url[1]);
  } else {
    url = "http://petstore.swagger.io/v2/swagger.json";

【讨论】:

    【解决方案3】:

    如果您要对 swagger-ui 进行大量自定义,我只建议将 swagger-ui 的私有副本添加到您的 Web 应用程序资源中,并根据您的需要修改 ui。

    与 springfox 捆绑的 Swagger-ui 是可选的

    【讨论】:

    • 如何理解“相当”?换个logo怎么样,需要密码登录才能根据不同的登录查看不同的内容?
    • 这是相当多的:)
    • @actan。你能改变招摇的标志吗?我正在拼命寻找一些线索来改变弹簧靴中的招摇标志。
    • @Avinash 是的,我将 swagger 静态资源复制到项目中并自定义了我需要的任何内容,徽标已更新
    • 如果你需要在 Swagger 中有授权按钮,那就不好了
    猜你喜欢
    • 1970-01-01
    • 2019-12-03
    • 2016-07-11
    • 2018-08-15
    • 2018-06-08
    • 2017-02-19
    • 1970-01-01
    • 2020-05-12
    • 1970-01-01
    相关资源
    最近更新 更多