Api-annotation die Beschreibung ist veraltet

In Fors, @Api annotation ist description ist veraltet.

Gibt es eine neuere Möglichkeit, die Beschreibung?

InformationsquelleAutor Soumitri Pattnaik | 2016-06-28
  1. 12

    Fand ich eine Lösung für mein Spring-Boot-Anwendung. Erstens, verwenden Sie die tags Methode für die tags angegeben, die Definitionen in Ihre Docket:

    @Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket productApi() {
        return new Docket(DocumentationType.SWAGGER_2).select()
                .apis(RequestHandlerSelectors.basePackage("my.package")).build()
                .apiInfo(apiInfo())
                .tags(new Tag("tag1", "Tag 1 description."),
                        new Tag("tag2", "Tag 2 description."),
                        new Tag("tag2", "Tag 3 description."));
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("My API").version("1.0.0").build();
    }
}

    Nachdem, in RestController fügen Sie einfach die @Api annotation mit einem (oder mehreren) der tags. Zum Beispiel:

    @Api(tags = { "tag1" })
@RestController
@RequestMapping("tag1Domain")
public class Tag1RestController { ... }
    • Beschreibung der Tag-der kommt nicht auf swagger-UI
    • Es funktioniert, wenn Sie eine genug neue version von Fors (zB. 2.9.x)
    • Perfekt. Allerdings, wenn es irgendeinen Weg gibt, wenn wir reduzierten Schriftgröße?
    InformationsquelleAutor falvojr
  2. 3

    Der Grund, warum es veraltet ist, dass die bisherigen Fors-Versionen (1.x) verwendet, die @Api Beschreibung Anmerkung zum group operations.

    In der Fors-2.0-Spezifikation, die Vorstellung von tags erstellt wurde und machte eine mehr flexible Gruppierung Mechanismus. Um API-konform, die description Feld wurde beibehalten, so dass upgrades wäre leicht, aber der richtige Weg, um eine Beschreibung hinzuzufügen ist, obwohl die tags - Attribut, das sollte eine Referenz @Tag annotation. Die @Tag ermöglicht es Ihnen, eine Beschreibung und auch externe links, etc.

    InformationsquelleAutor fehguy
  3. 3

    Dies ist der richtige Weg, um Sie auf Beschreibung hinzufügen, um Ihre Fors-API documentetion für v1.5:

    @Api(tags = {"Swagger Resource"})
@SwaggerDefinition(tags = {
    @Tag(name = "Swagger Resource", description = "Write description here")
})
public class ... {
}
    • Das sieht aus wie ein guter Weg, es zu tun, aber was, wenn Sie die Wiederverwendung der tag auf mehreren APIs ? wo würde u stellen SwaggerDefinition ? Ich habe versucht, es auf meinem SwaggerConfig bean, aber es wurde nicht berücksichtigt. Nur das Programm Weg war für mich.
    • auf diese Weise können nicht arbeiten in springfox-swagger-ui 2.9.2
    InformationsquelleAutor zappee
  4. 0

    Auch ich fragte mich, was zu tun ist über die Verwendung des veralteten description (zeigt sich als Warnungen in meinem IDE).

    Gut, bei näherem hinsehen stellte sich heraus, dass description ist nicht überall im Swagger-UI. Danach wird die Lösung (in unserem Falle*) war klar: entfernen Sie einfach die Beschreibungen.

    (*In unserer codebase, mit sauberen Klassen-und Methodennamen usw, es war sicherlich keine Notwendigkeit für solche "API-Beschreibungen" für den Leser des Codes. Ich hätte toleriert, dass diese bits von Swagger-Lärm in der codebase, wenn Sie Hinzugefügt einige Wert in Swagger-UI, aber da Sie nicht, die einzige vernünftige Sache war, um Sie wegzuwerfen.)

    InformationsquelleAutor Jonik
  5. 0

    Ich habe versucht, oben genannten Lösungen, aber Sie funktionieren nicht für mich.

    Hinzufügen einen Titel und eine Beschreibung in der Dokumentation, die Sie erstellen, ApiInfo und Kontakt Objekte, wie im Beispiel unten.
    Dann fügen Sie einfach apiInfo Objekt Swagger Laufzettel.

    import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;

@EnableSwagger2
@Configuration
public class SwaggerConfig {

  private Contact contact = new Contact("", "", "");
  private ApiInfo apiInfo = new ApiInfo(
      "Backoffice API documentation",
      "This page documents Backoffice RESTful Web Service Endpoints",
      "1.0",
      "",
      contact,
      "",
      "");

  @Bean
  public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo)
        .select()
        .apis(RequestHandlerSelectors.basePackage(
            PaymentsController.class.getPackage().getName()
        ))
        .paths(PathSelectors.ant("/api/v1/payments" + "/**"))
        .build()
        .useDefaultResponseMessages(false)
        .globalOperationParameters(
            newArrayList(new ParameterBuilder()
                .name("x-authorization")
                .description("X-Authorization")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .build()));
  }
}

    Obige code erzeugt eine Beschreibung, wie im screenshot unten.

    kann jemand mit mehr Ruf mich bitte Bearbeiten Sie post und fügen Sie dieses Bild https://i.stack.imgur.com/YUjbr.png

    InformationsquelleAutor davrog10
Schreibe einen Kommentar