2016-03-22 6 views
5

Ich benutze Springfox Swagger-Implementierung. Ich möchte die swagger-ui.html ändern, um einen benutzerdefinierten Header-Wert zu nehmen. Wie ändere ich diese Datei? Oder sag Spring Fox eine alternative Datei zu benutzen?Wie kann ich swagger-ui.html für Springfox ändern?

+0

Ich konnte dies durch hier folgen Sie den Anweisungen acheive: https://github.com/springfox/springfox/issues/1176 Grundsätzlich können Sie die Quelle nach unten ziehen und machen was auch immer Änderungen, die Sie muss machen. Sie müssen kein Web-Jar erstellen. Kopieren Sie es einfach in Ihre Ressourcen und lassen Sie Ihre App mit den Ressourcen-Handlern umgehen. –

Antwort

2

Wenn Sie swagger-ui ziemlich anpassen möchten, würde ich nur empfehlen, eine private Kopie von swagger-ui zu Ihren Webanwendungsressourcen hinzuzufügen und das ui entsprechend Ihren Bedürfnissen zu modifizieren.

Swagger-ui gebündelt mit Springfox ist optional.

+0

Wie verstehen Sie "ziemlich"? Was ist mit dem Ändern des Logos, erfordern Passwort, um sich anzumelden, um verschiedene Inhalte zu sehen und zu sehen, basierend auf verschiedenen Login? – actan

+1

Das ist ziemlich viel :) –

0

Ja, die Prahlerei ui in Ihr Projekt ziehen und die Schritte, die hier folgen: https://github.com/springfox/springfox/issues/1176

dann die index.html bearbeiten und ändern, in dem es um die petstore zu Ihrem Endpunkt verweist. (d. h. "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"; 
1
  1. Pull Swagger UI von GitHub.

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

  2. Copy Paste & dist Verzeichnis von Prahlerei ui Ressourcen in Prahlerei Config Verzeichnis

  3. den Code ersetzen

    mit unter

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

    mit

    registry.addResourceHandler("**").addResourceLocations("classpath:/dist/"); 
    
  4. ändern Pfad des API-Dokumentation in index.html auf Ihren Weg

    ersetzen

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

    Mit

    http://localhost:8080/your_app/v2/api-docs 
    
  5. Verwenden Sie das folgende URL-Muster zu Siehe die Seite

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

Verwandte Themen