swagger ui
v5.18.2 Released!
L'interface utilisateur de Swagger permet à quiconque - soit votre équipe de développement ou vos consommateurs finaux - à visualiser et à interagir avec les ressources de l'API sans aucune logique d'implémentation en place. Il est automatiquement généré à partir de votre spécification OpenAPI (anciennement connue sous le nom de Swagger), la documentation visuelle facilitant la mise en œuvre de l'arrière et la consommation latérale du client.
? Vous voulez marquer une contribution facile à l'ouverture? Découvrez notre bonne étiquette de premier numéro.
? ️ Vous cherchez l'ancienne version de l'interface utilisateur de Swagger? Reportez-vous à la branche 2.x.
Ce référentiel publie trois modules NPM différents:
Nous vous suggérons fortement d'utiliser swagger-ui au lieu de swagger-ui-dist si vous construisez une application à une seule page, car swagger-ui-dist est nettement plus grande.
Si vous recherchez un ordinateur html / js / css, téléchargez la dernière version et copiez le contenu du dossier /dist sur votre serveur.
La spécification OpenAPI a subi 5 révisions depuis la création initiale en 2010. La compatibilité entre l'interface utilisateur de Swagger et la spécification OpenAPI est la suivante:
| Version de l'interface utilisateur Swagger | Date de sortie | Compatibilité des spécifications OpenAPI | Notes |
|---|---|---|---|
| 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 utilise un écharpe pour collecter des analyses d'installation anonymisées. Ces analyses aident à soutenir les mainteneurs de cette bibliothèque et à exécuter uniquement pendant l'installation. Pour vous retirer, vous pouvez définir le champ scarfSettings.enabled sur false dans package.json de votre projet.json:
// package.json
{
// ...
"scarfSettings": {
"enabled": false
}
// ...
}
Alternativement, vous pouvez définir la variable d'environnement SCARF_ANALYTICS sur false dans le cadre de l'environnement qui installe vos packages NPM, par exemple, SCARF_ANALYTICS=false npm install .
Vous aurez besoin de JDK de la version 7 ou supérieure comme indiqué ici https://nightwatchjs.org/guide/getting-started/installation.html#install-selenium-server
Les tests d'intégration peuvent être exécutés localement avec npm run e2e - assurez-vous que vous n'exécutez pas de serveur de développement lors des tests!
Swagger UI fonctionne dans les dernières versions de Chrome, Safari, Firefox et Edge.
Pour aider à la migration, voici les problèmes actuellement connus avec 3.x. Cette liste mettra à jour régulièrement et n'inclura pas de fonctionnalités qui n'ont pas été implémentées dans les versions précédentes.
collectionFormat est partielle.Veuillez divulguer tous les problèmes ou vulnérabilités liés à la sécurité en envoyant un e-mail à [email protected], au lieu d'utiliser le tracker des problèmes publics.
Swaggerui est sous licence Apache 2.0. SwaggerUi est livré avec un fichier d'avis explicite contenant des avis et informations juridiques supplémentaires.
