Serveur fantaisie Swagger/OpenAPI

Question

J'ai une référence d'API dans un fichier Swagger. Je veux créer un serveur fantaisie très simple, de sorte que lorsque j'appelle par exemple :

mymockurl.com/users il retournera un JSON prédéfini (pas besoin de se connecter à une base de données).

Quel est le moyen le plus simple de le faire ? Je ne suis pas un spécialiste du backend.

Answer 1

Un moyen facile de créer une maquette simple à partir d'une spécification OpenAPI (fka Swagger) sans code est d'utiliser un outil appelé prisme disponible à l'adresse http://github.com/stoplightio/prism écrit en tapuscrit.

Cette ligne de commande est tout ce dont vous avez besoin :

./prism run --mock --list --spec <your swagger spec file>

Le serveur fantaisie renverra une réponse dynamique basée sur la spécification OpenAPI. Si des exemples sont fournis dans la spécification, prism les retournera, sinon il générera des données factices basées sur la spécification.

Edit (août 2020) :

La commande a changé dans la dernière version. Ce qui suit fera l'affaire :

prism mock <your spec file>

Il accepte également swagger et postman doc.

Answer 2

SwaggerHub fournit un serveur fantaisie pour les spécifications OpenAPI 2.0 et 3.0. Le mocking est supporté à la fois sur les plans gratuits et payants.

Pour utiliser le serveur fantaisie, importez votre spécification dans SwaggerHub et activez "API Auto Mocking". Les réponses fantaisie peuvent être JSON, YAML et XML, et sont générées sur la base de vos schémas de réponse et de l'attribut example , default y enum valeurs définies dans les schémas.

Divulgation : Je travaille pour la société qui fait SwaggerHub.

Answer 3

Imposteur est un un serveur fantaisie polyvalent et scriptable écrit en Java.

Très facile à mettre en place dans un Docker et fournit un Interface utilisateur Swagger pour jouer avec votre API fantaisie.

Voyons un exemple de configuration

1. Avoir une configuration swagger prête dans un fichier dans le dossier config/petstore.yaml

    swagger: "2.0"
    info:
    version: 1.0.0
    title: Swagger Petstore
        .
        .
        .

Vous pouvez copier l'exemple de spécification swagger à partir de aquí .

2. Créer un fichier de configuration pour Imposteur en config/openapi-plugin-petstore-config.json

    {
      "plugin": "com.gatehill.imposter.plugin.openapi.OpenApiPluginImpl",
      "specFile": "petstore.yaml"
    }

   Le nom du fichier de configuration doit se terminer par -config.json .

3. Ejecutar Imposteur con Docker

   Assurez-vous que votre shell est placé dans le répertoire parent de config et exécuter

    docker run -ti -p 8443:8443 \
    -v $(pwd)/config:/opt/imposter/config \
    outofcoffee/imposter-openapi

4. Abrir http://localhost:8443/_spec/ pour jouer avec votre serveur Mock et votre interface utilisateur Swagger.

   

Answer 4

Compte tenu de la spécification OpenAPI/Swagger, vous pouvez utiliser Swagger Codegen pour générer des stub de serveur dans différents frameworks de serveur (par exemple Java Spring. PHP Slim, Ruby on Rails5, etc).

Voici la documentation correspondante :

https://github.com/swagger-api/swagger-codegen/wiki/Server-stub-generator-HOWTO

MISE À JOUR : en mai 2018, une cinquantaine des principaux contributeurs de Swagger Codegen ont décidé de bifurquer le projet pour créer une version communautaire appelée Générateur OpenAPI . Veuillez vous référer à la QUESTIONS ET RÉPONSES pour les raisons derrière la fourche.

Answer 5

Voici le conteneur docker pour le serveur api fictif à partir de swagger yaml.

docker run -i \
    -p 8000:8000 \
    -v /path/to/file.yaml:/data/swagger.yaml \
    -t palo/swagger-api-mock:latest

En interne, on utilise swagger-mock-api