swagger ui
v5.18.2 Released!
Die Swagger UI ermöglicht jedem - sei es Ihr Entwicklungsteam oder Ihre Endverbraucher - die Ressourcen der API, ohne die Implementierungslogik zu haben. Es wird automatisch aus Ihrer OpenAPI -Spezifikation (früher als Swagger bekannt) generiert. Die visuelle Dokumentation erleichtert es für die Implementierung von Back -End und die Kundenseite.
? Möchten Sie einen einfachen Open-Source-Beitrag erzielen? Schauen Sie sich unser gutes Erstausgabe -Label an.
"Auf der Suche nach der älteren Version von Swagger UI? Siehe 2.x Branch.
Dieses Repository veröffentlicht drei verschiedene NPM -Module:
Wir schlagen nachdrücklich vor, dass Sie swagger-ui anstelle von swagger-ui-dist verwenden, wenn Sie eine einseitige Anwendung bauen, da swagger-ui-dist erheblich größer ist.
Wenn Sie nach einfachem HTML/JS/CSS auf der Suche sind, laden Sie die neueste Version herunter und kopieren Sie den Inhalt des Ordners /dist auf Ihren Server.
Die OpenAPI -Spezifikation wurde seit der ersten Schaffung im Jahr 2010 überarbeitet. Die Kompatibilität zwischen der UI der Swagger und der OpenAPI -Spezifikation lautet wie folgt:
| Swagger UI -Version | Veröffentlichungsdatum | OpenAPI -Spezifikation Kompatibilität | Notizen |
|---|---|---|---|
| 5.0.0 | 2023-06-12 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0 | Tag v5.0.0 |
| 4.0.0 | 2021-11-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | Tag v4.0.0 |
| 3.18.3 | 2018-08-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | Tag v3.18.3 |
| 3.0.21 | 2017-07-26 | 2.0 | Tag v3.0.21 |
| 2.2.10 | 2017-01-04 | 1,1, 1,2, 2.0 | Tag v2.2.10 |
| 2.1.5 | 2016-07-20 | 1,1, 1,2, 2.0 | Tag v2.1.5 |
| 2.0.24 | 2014-09-12 | 1.1, 1.2 | Tag v2.0.24 |
| 1.0.13 | 2013-03-08 | 1.1, 1.2 | Tag v1.0.13 |
| 1.0.1 | 2011-10-11 | 1.0, 1.1 | Tag v1.0.1 |
Swaggerui verwendet Schal, um anonymisierte Installationsanalysen zu sammeln. Diese Analyse unterstützen die Betreuer dieser Bibliothek und läuft nur während der Installation. Um sich zu entscheiden, können Sie das Feld von scarfSettings.enabled in das false Ihres Projekts in package.json des Projekts einstellen.
// package.json
{
// ...
"scarfSettings": {
"enabled": false
}
// ...
}
Alternativ können Sie die Umgebungsvariable SCARF_ANALYTICS als Teil der Umgebung auf false einstellen, die Ihre NPM -Pakete installiert, z SCARF_ANALYTICS=false npm install
Sie benötigen JDK von Version 7 oder höher, wie es hier angewiesen wird
Integrationstests können lokal mit npm run e2e durchgeführt werden. Stellen Sie sicher, dass Sie beim Testen keinen Dev -Server ausführen!
Die Swagger UI arbeitet in den neuesten Versionen von Chrome, Safari, Firefox und Edge.
Um bei der Migration zu helfen, finden Sie hier die derzeit bekannten Probleme mit 3.x. Diese Liste wird regelmäßig aktualisiert und keine Funktionen enthalten, die in früheren Versionen nicht implementiert wurden.
collectionFormat ist teilweise.Bitte geben Sie alle sicherheitsrelevanten Probleme oder Sicherheitslücken an, indem Sie [email protected] per E-Mail anstatt den öffentlichen Problem Tracker zu verwenden.
Swaggerui ist unter Apache 2.0 -Lizenz lizenziert. Swaggerui verfügt über eine explizite Kündigungsdatei mit zusätzlichen rechtlichen Mitteilungen und Informationen.
