meilleure façon de dire swaggerui où l'hôte est

Quand je construire mon style.fichier json je ne sais pas qui de l'hôte à utiliser. Cependant, je peux travailler quand ma page qui héberge swaggerui charges (en fait j'ai envie d'offrir à l'utilisateur un choix). J'espère le voir options.accueil sur la config pour le swaggerUI objet - je ne vois pas. Est-il un moyen de faire ce que je ne peux pas trouver ou dois-je tout simplement pirater mon chemin à travers le code et ajouter cette fonctionnalité (les pointeurs vers le meilleur endroit pour le faire serait la bienvenue)

source d'informationauteur pm100 | 2015-06-19

  1. 4

    Swagger a un haut-json définition de l'hôte de config, ou d'accepter plusieurs entrées.

    {
    "swagger": "2.0",
    "info": {
        "title": "Why API",
        "description": "Don't make that mistake again",
        "version": "0.0.1"
    },

    "host": "127.0.0.1:3000",
    "schemes": [
        "https"
    ]
}

    Ou

    "host": "test.mydomain.com:3000",
"schemes": [
    "https"
],

    Ou vous pouvez avoir une dynamique de l'hôte par la définition d'un var et l'appel d'un nom d'hôte ou le nom de la machine ou d'autres variables d'environnement.

    dynamique exemple

    if (typeof this.host === 'undefined' || this.host === '') {
  this.host = location.host;
}
if (location.port) {
  this.host = this.host + ':' + location.port;
}
  2. 3

    deux façons

    Une modification swagger.js de sorte qu'il accepte l'option hôte. swagger-UI passe options de swagger-js donc, qui fonctionne. J'ai soumis un pull à swagger-js avec ce correctif

    Deuxième choix est que swagger-INTERFACE utilisateur accepte un 'spec' paramètre. Cela signifie que la page qui l'héberge pouvez charger l'arrogance.fichier json, JSON.analyser , la mettre de l "hôte", puis passez à la swaggerUi constructeur. C'est plus difficile pour l'appelant, mais ne nécessite pas de modification de code à swagger

  3. 3

    Voici ce que je fais, depuis le chargement dans le document est juste un objet JSON:

    var swaggerDoc = require('./api/swagger.json');
if (process.env.NODE_ENV === 'development') {
  swaggerDoc.host="localhost:" + process.env.PORT
}

//Initialize the Swagger middleware
swaggerTools.initializeMiddleware(swaggerDoc, function (middleware) {
  //Other initialization
}

    De cette façon, vous ne pollue pas votre spécification de l'API avec l'environnement de développement de configuration.

  4. 2

    Dans les versions récentes de Style de l'INTERFACE utilisateur, il est possible de le faire, par exemple dans onComplete:

    window.swaggerUi.api.setHost("your.host:4242");

  5. 1

    Si vous êtes l'héberger sur le même serveur d'application, il suffit de retirer la clé d'hôte du json et de fournir chemin relatif dans la clé "basePath". as -
    "basePath": "/repos/createcampaign".

  6. 0

    C'est la façon dont je l'ai fait à l'aide de la client Java:

    DefaultApi api = new DefaultApi();
api.getApiClient().setBasePath("http://localhost:8080");
//call the API