Réglage de la Version de l'Api avec Swagger de l'INTERFACE utilisateur

J'ai une API REST développé grâce à l'utilisation de Jersey et du document, nous avons le RESTE de l'API par le biais de swagger-ui. Malheureusement, nous n'avons pas de démarrage gestion des versions de l'API de 1 jour. Nous essayons maintenant d'ajouter la gestion des versions pour l'API.

La première étape que je prends c'est que je suis en train de mettre à jour la version de l'API qui est affiché par l'généré dynamiquement swagger (html) de la page. J'ai retracé le flux d'appels tout le chemin à la swagger-ui.js fichier mais je ne peux pas comprendre comment modifier l'affichage de la version de l'API au bas de la page générée dynamiquement.

La valeur par défaut qui est affiché en bas est ' API VERSION: 1.0.0 '.

J'ai lu quelque chose à propos d'un ServiceStack ici mais malheureusement le code de base que je suis en train de travailler sur ne pas utiliser quoi que ce soit de la sorte.

Quelqu'un pourrait s'il vous plaît veuillez m'indiquer où/quoi j'aurais besoin de modifier/mettre à jour pour mettre à jour l'affichage de la version de l'API numéro?

InformationsquelleAutor Henry Lin | 2016-03-03
  1. 1

    Vous pouvez ajouter un Bootstrap servlet pour définir les paramètres de la Fanfaronnade config bean comme décrit ici -

    https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-Jersey-2.X-Project-Setup-1.5

    InformationsquelleAutor Sampada
  2. 2

    Version de l'API affiche au bas de l'Arrogance de l'INTERFACE utilisateur est à venir à partir de l'Arrogance document.

    Voici un exemple Swagger document:

    {
    "swagger": "2.0",
    "info": {
        "description": "This is a sample server Petstore server.",
        "version": "1.0.0",
        "title": "Swagger Petstore",
    ...

    "version": "1.0.0" est la valeur par défaut mais vous pouvez le modifier à l'aide de l'Arrogance @Info annotation:

    @SwaggerDefinition(
    info = @Info(
        description = "This is a sample server Petstore server.",
        version = "1.0.1",
        title = "Swagger Petstore"

    Ce document peut être ajouté à n'importe quelle classe analysés au cours de l'Arrogance de l'auto-configuration par le Swagger page Wiki:

    L'annotation peut être sur n'importe quelle classe analysés au cours de l'Arrogance de l'auto-configuration, c'est à dire qu'il n'a pas à être sur une API JAX-RS classe mais pourraient être un marqueur/config de l'interface

    Vous pouvez trouver quelques échantillons ici: https://github.com/swagger-api/swagger-samples/tree/master/java. Certains sont à l'aide de Jersey et le réglage de la version de l'API.

    • Merci pour la réponse. Savez-vous ce que j'ai besoin de balise avec le @SwaggerDefinition?
    • Je crains que vous devez ajouter le @SwaggerDefinition annotation car en regardant la @Info application vous pouvez voir que c'est annotée avec @Target(ElementType.ANNOTATION_TYPE) qui en fait une déclaration de type.
    InformationsquelleAutor Navid Shakibapour
  3. 1

    Il est assez franc -

    1. Add a servlet to set the Swagger Bootstrap properties in your deployment descriptior file.
<servlet>
        <servlet-name>SwaggerBootstrap</servlet-name>
        <servlet-class>com.example.util.SwaggerBootstrap</servlet-class>
        <init-param>
            <description>URL Pattern Mapping</description>
            <param-name>paramName</param-name>
            <param-value>uri value</param-value>
        </init-param>
        <load-on-startup>2</load-on-startup>
    </servlet>

2. Create a servlet and set the Bean properties as below --

public void init(ServletConfig servletConfig) 
{
        try {

            //Setting the BeanConfig for start-up page
            BeanConfig bean = new BeanConfig();
            bean.setScan(true);
            bean.setResourcePackage("com.example.util");
            bean.setBasePath("yourBasePath"));  
            bean.setVersion("1.0");
            bean.setTitle("title"));
            bean.setDescription("description");

        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    • Oui depuis, j'ai pensé à elle. Merci. En fait il y a une question que j'ai ouvert sur les projets github avec la modification du titre et version par l'intermédiaire de l'objet de configuration de la méthode.. grains de Mais fonctionne très bien.
    InformationsquelleAutor Anand Bansal