Die Einstellung der Api-Version mit Swagger-UI

Habe ich eine REST-API entwickelt, die durch die Verwendung von Jersey und dokumentieren wir die REST API, durch swagger-ui. Leider hatten wir nicht starten Versionierung der API von Tag 1. Wir werden jetzt versuchen, fügen Sie die Versionierung der API.

Den ersten Schritt, den ich mache ist, ich bin versucht, zu aktualisieren der API-version, die angezeigt wird durch den dynamisch generierten swagger (html) - Seite. Ich habe zurückverfolgt, call-flow, den ganzen Weg zu dem swagger-ui.js Datei, aber ich kann nicht herausfinden, wie man den angezeigten API-version am unteren Rand der dynamisch generierten Seite.

Dem Standard, der derzeit am unteren Rand angezeigt wird ' API VERSION: 1.0.0 '.

Habe ich etwas gelesen über einen ServiceStack hier aber leider die code-Basis arbeite ich nicht alles verwenden, was von der Art.

Könnte jemand bitte zeigen Sie mir, wo/was müsste ich ändern/aktualisieren, um die Aktualisierung der angezeigten API-Versionsnummer?

InformationsquelleAutor Henry Lin | 2016-03-03

  1. 1

    Können Sie eine Bootstrap-servlet, um die Parameter für das Swagger config bean, wie hier beschrieben -

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

    InformationsquelleAutor Sampada

  2. 2

    API-version am unteren Rand angezeigt von der Swagger-UI kommt aus dem Fors-Dokument.

    Hier ist ein Beispiel Swagger Dokument:

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

    "version": "1.0.0" ist die Standardeinstellung, aber Sie können es ändern, mit dem Swagger @Info Anmerkung:

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

    Diesem Dokument Hinzugefügt werden können, um jede Klasse gescannt, während Fors auto-Konfigurations-Prozesses gemäß der Swagger Wiki-Seite:

    Die annotation kann auf class gescannt, während Fors auto-Konfiguration, d.h. es muss nicht auf eine JAX-RS-API-Klasse, sondern konnte nur auf einen marker/config interface

    Finden Sie einige Beispiele hier: https://github.com/swagger-api/swagger-samples/tree/master/java. Einige sind mit Jersey und Einstellung der API-version.

    Danke für die Antwort. Wissen Sie, was ich brauche, um tag mit der @SwaggerDefinition?
    Ich fürchte, Sie haben zum hinzufügen von @SwaggerDefinition Anmerkung, da durch die Betrachtung der @Info Umsetzung, Sie können sehen, dass es kommentiert mit @Target(ElementType.ANNOTATION_TYPE) wodurch es zu einer Typ-Deklaration.

    InformationsquelleAutor Navid Shakibapour

  3. 1

    Es ist ziemlich straight-forward -

    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();
        }
    }
    Ja das habe ich da herausgefunden. Danke. Eigentlich gibt es ein Problem, ich öffnete auf der github-Projekte mit der änderung der Titel und die version über den Objekt-Konfiguration Methode.. Aber Bohnen funktioniert Prima.

    InformationsquelleAutor Anand Bansal

Schreibe einen Kommentar