Comment lancer Swagger UI et Swagger Editor dans Docker
Qu'est-ce que Swagger
Swagger est un cadre de construction d'API qui peut faire des demandes de conception de documents API et de simulations d'API (prototypes). Les outils Swagger utilisés cette fois sont les trois suivants.
| outil | Explication |
|---|---|
| Swagger Spec | (Spec = Specification = Specification) Ceci est un document lié aux spécifications de Swagger, et est YAML./Écrit au format JSON. |
| Swagger Editor | Un outil qui peut éditer les fichiers Swagger Spec qui s'exécutent sur le navigateur et vérifier la syntaxe en temps réel. |
| Swagger UI | Un outil qui génère dynamiquement des documents à partir de Swagger Spec. |
Pour les autres outils relatifs à Swagger, veuillez consulter le lien sur la page officielle.
À propos de la relation entre les outils Swagger
Tout d'abord, j'ai essayé d'illustrer comment Swagger Editor et Swagger UI sont utilisés, avec la génération de fichier Swagger Spec comme axe principal. En tant qu'image utilisée cette fois, utilisez Swagger Editor pour modifier et définir SwaggerSpec qui est la spécification de l'API sur le navigateur, et si vous pouvez confirmer la syntaxe, entrez-la dans le fichier yaml réel et faites-la référence à partir de l'interface utilisateur de Swagger. C'est un flux.
procédure
Point de réglage:
- Configurez
docker-compose.ymlpour créer des images de Swagger Editor et Swagger UI. - Placez la définition Swagger comme «sample.yaml».
docker-compose.yml
version: '3.7'
services:
swagger-editor:
image: swaggerapi/swagger-editor
ports:
- "8001:8080"
swagger-ui:
image: swaggerapi/swagger-ui
ports:
- "8002:8080"
volumes:
- ./sample.yaml:/sample.yaml
environment:
SWAGGER_JSON: sample.yaml
Structure du répertoire
├── docker-compose.yaml
└── sample.yaml
Procédez comme suit dans le terminal:
Terminal
$ docker-compose up
Swagger Editor commence à https: // localhosst: 8001, et Swagger UI commence à https: // localhost: 8002.
Recommended Posts