springfox - 如何为 springfox 修改 swagger-ui.html？

Question

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

Answer 1

1. 从 github 拉出 Swagger UI。

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

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

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

Answer 2

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

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

Answer 3

是的，将 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";