comment intégrer swagger avec ma demande expresse
Toujours que j'ai utilisé pour partager mon nœud du côté des services à certains autres équipes avec la documentation appropriée. Basé sur cette documentation, ils feront appel à mes services.
À ce sujet, quand j'ai parlé avec un gars. Il m'a suggéré d'utiliser swagger
. Mais je n'ai aucune idée de comment l'intégrer à mon application.
Mon application écrite en Express
. J'ai fait une recherche sur ce dans google, je n'ai pas trouvé de tutoriel. Si quelqu'un implémente déjà, pouvez-vous me suggérer. Le module qui est bon et comment.
Aussi simplement curieux de savoir, ils sont tout autres bibliothèques, comme swagger
, qui prend en charge Node
plate-forme.
Grâce
OriginalL'auteur grandhi | 2015-12-13
Vous devez vous connecter pour publier un commentaire.
J'ai de l'expérience avec la documentation Expresse de l'API à l'aide d'un module express (
swagger-node-express
). J'ai également de l'expérience avec la documentation Expresse de l'API à l'aide de manuel Swagger JSON docs.Je recommanderais de ne pas vous attacher vers le bas pour un module pour votre Swagger docs. La plupart des modules (et surtout swagger-nœud-express) vous forcer à écrire votre Express code différemment pour gérer la documentation. Lors de l'écriture manuelle de votre Swagger docs avec JSON, vous êtes capable d'écrire Exprimer et de découpler la documentation de votre routage.
Utilisation Swagger de l'INTERFACE utilisateur pour le style de votre documentation et de l'ajouter à votre page web.
Voici quelques ressources que vous pouvez utiliser lors du démarrage:
Swagger Éditeur modifier votre swagger docs et de voir vos modifications, mise à jour en direct
Swagger Docs - Swagger spécifications pour JSON
Tutoriel Il utilise une ancienne version de Swagger, assurez-vous de vérifier La Migration De Swagger à la mise à niveau vers la version la plus récente
Aussi, jetez un oeil à cette réponse expliquant la différence entre le manuel et le module de base de swagger doc génération -> ICI.
OriginalL'auteur Mike
Je ne suis pas complètement clair sur ce que votre demande mais je pense que vous êtes à la recherche de quelque chose comme ceci: swagger-outils
- Je utiliser ce module et il a été formidable. Il expose quelques middleware qui vous pouvez lier à l'Express
app
que vous créez. Par exemple, si vous avez votre service documenté et que la documentation est Swagger conforme, vous pouvez transmettre ce document au middleware. Les middlewares, certaines choses merveilleuses comme le câblage demande des gestionnaires sur la base des définitions que l'on trouve dans la documentation et la validation des demandes de définitions qui se trouvent dans votre documentation.Il a une grande tutoriel et il est super facile d'obtenir le programme d'installation. J'espère que cette aide et de l'est, le long de la lignes de ce que vous recherchez.
OriginalL'auteur Michael Jonas
J'ai récemment rencontré la mise en œuvre de la documentation de l'API à l'aide de swagger. J'ai utilisé "swagger-ui-express" npm module pour le mettre en œuvre.
Créé JSON à l'exécution, c'est à dire, une fois que le serveur commence à courir, j'ai données saisies et modifiées en fonction de l'aisance spécifications comme le fichier ci-dessous.
https://editor.swagger.io/ Ici, vous pouvez voir l'arrogance des spécifications en JSON.
Exigent le "swagger-ui-express" module, créez un JSON et d'alimenter le fichier de swaggerui comme ci-dessous.
OriginalL'auteur Mythili
- Je utiliser swagger comme ça parce qu'il me donne vivre docs automatiquement sur mon express apps:
Ensuite, c'est juste question de la création de la route où vous voulez que votre docs à vivre:
Voir comment swagger-ui-express han prise en charge intégrée pour swagger-jsdoc. Lire swagger-ui-express et swagger-jsdocs documentation de démarrage pour plus d'info.
Spécification de l'API exemple:
Prises à partir de la swagger-jsdocs documentation de démarrage.
Généré docs exemple:
Ils regardent presque comme le Swagger exemple de l'INTERFACE utilisateur.
Je vous conseillerais donc de suivre la réponse de Mike depuis j'en ai conclu son mieux de cette façon. Avec jsons découplé du code
OriginalL'auteur Martin Schaer