Configuration d'une instance Swagger locale

Vous pouvez utiliser une instance Swagger locale pour examiner et tester de nouvelles API REST.

Utilisez les instructions suivantes pour installer une instance locale de l'éditeur Swagger open source basé sur navigateur pour concevoir des API REST de document créées à l'aide de la spécification Swagger. L'éditeur fonctionne en parallèle avec l'interface utilisateur Swagger, que vous installez également localement. Les conteneurs Docker préintégrés sont disponibles pour les deux outils, vous pouvez donc les installer facilement sur n'importe quel serveur compatible Docker.

  1. Pour déployer le conteneur de l'éditeur Swagger, exécutez les commandes suivantes :
    • docker pull swaggerapi/swagger-editor
    • docker run -d -p 5440:8080 swaggerapi/swagger-editor
  2. Pour afficher l'éditeur Swagger, accédez à http://localhost:5440/
  1. Pour déployer le conteneur d'interface utilisateur Swagger, exécutez les commandes suivantes.
    • docker pull swaggerapi/swagger-ui
    • docker run -d -p 5440:8080 swaggerapi/swagger-editor
  2. Pour afficher l'interface utilisateur Swagger, accédez à http://localhost:5440/.

Assurez-vous de mettre sur liste blanche l'éditeur/le domaine d'interface utilisateur Swagger en l'ajoutant dans votre configuration CORS. Pour plus d'informations sur la configuration du partage de ressources d'origine croisée, voir Configuring Cross-Origin Resource Sharing (CORS) headers.

Pour plus d'informations sur l'utilisation de Swagger pour afficher et valider de nouvelles API REST, voir Test des API REST.