web-dev-qa-db-fra.com

Comment démarrer avec swagger-ui

Qu'est-ce que swagger-ui et à quoi sert-il?

Existe-t-il de bonnes ressources pour démarrer avec swagger-ui? De bons tutoriels, blogs ou livres?

je visite également http://swagger.io/ mais j'ai besoin de plus d'informations.

guidez-moi s'il-vous-plaît. Merci d'avance

22

Swagger UI est un outil qui prend les fichiers de spécifications Swagger, les présente visuellement et vous permet d'exécuter des opérations.

Swagger lui-même est une spécification pour documenter et décrire les API REST. La spécification peut être trouvée ici - https://github.com/swagger-api/swagger-spec/ =. Le référentiel contient la spécification elle-même, le schéma json, des exemples, etc. Le principal README du référentiel vous indique également des outils supplémentaires, notamment des bibliothèques et des frameworks pour produire vos spécifications.

Lorsqu'il s'agit de créer une spécification Swagger, vous pouvez utiliser l'un des frameworks et l'intégrer au code existant pour générer automatiquement une telle documentation.

Si vous n'avez pas d'application existante ou préférez la documenter manuellement, vous pouvez utiliser l'outil Swagger-Editor ou l'éditeur de texte de votre choix.

18
Ron