Verwendung von Swagger2 und Erklärung der Annotation im SpringBoot-Projekt

1. Importieren Sie die Swagger-Koordinatenabhängigkeit bereitgestellt von Springfox kann Swagger2-bezogene Technologie aktivieren. Das Programm durchläuft alle Typen im Paket und seinen Unterpaketen der aktuellen Klasse, um Anmerkungen zu Swagger zu finden und das Swagger-Dokument anzupassen

3. Starten Sie das Projekt und sehen Sie sich die swaggerui.html-Schnittstelle an

Klicken Sie auf „Ausprobieren“, um die entsprechenden Parameter einzugeben und die Rückgabeergebnisse anzuzeigen.

Viertens schreiben Sie die SwaggerConfig-Konfigurationsdatei. Docker ist das globale Konfigurationsobjekt in Swagger

Verwenden Sie DocumentationType.SWAGGER_2, um das Klassenobjekt von Docket anzugeben und zu bestimmen, welche Version verwendet wird

apiInfo(): die Beschreibungsinformationen des API-Dokuments, der Parameter ist ein ApiInfo-Klassenobjekt, verwendet bulid() Builder zum Erstellen von

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${swagger.version}</version>
</dependency>

contact(): Konfigurieren Sie den Hauptinhalt des Swagger-Dokuments, das auch ein Klassenobjekt ist. Das Klassenobjekt kann bis zu drei Parameter haben: Publisher-Name, URL-Adresse der Website des Dokumentherausgebers ( Unternehmenswebsite), die E-Mail-Adresse des Dokumentherausgebers ApiSelectorBuilder ist select(), Wird verwendet, um Selektoren in Docker abzurufen. Erstellen Sie Selektoren. Zum Beispiel, welche Paketanmerkungen gescannt werden

apis(): gefolgt von den (Prädikat-)Regeln unter der RequestHandlerSelectors-Klasse, die die Anmerkungen der zu scannenden Pakete festlegen. Standardmäßig sind die Anmerkungen unter der Startup-Klasse und ihren Unterpaketen

Wie viele statische Methoden gibt es in der RequestHandlerSelectors-Klasse (drei Beispiele)

basePackage(): Geben Sie später die spezifische Adresse des Paketnamens ein, und die Anmerkungen des geänderten Pakets und seiner Unterpakete werden gescannt

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${swagger.version}</version>
</dependency>

any(): API-Dokumentation für jede Schnittstelle generieren

none(): Für keine Schnittstelle wird ein Schnittstellendokument generiert

path(): Verwenden Sie reguläre Ausdrücke, um die Pfadadresse des generierten API-Dokuments einzuschränken, und Füllen Sie dann den gefilterten (übergebenen) Pfad aus

Sechs: Swagger2 allgemeine Anmerkungen

@Api (häufig verwendet)

Funktion

: @Api ist eine Anmerkung zu einer Klasse. Steuern Sie den Inhalt der von der gesamten Klasse generierten Schnittstelleninformationen

Attribute:

Tags: Der Name der Klasse. Wenn mehrere Werte vorhanden sind, was bedeutet, dass mehrere Kopien (Aliase) verfügbar sind, zeigt die SwaggerUI-Ansicht an, von welchen Controllern aus auf das Menü zugegriffen werden kann

Beschreibung: Beschreibung, veraltet

@ApiOperation

Funktion

: @ApiOperation ist eine Anmerkung zur Methode, die die relevanten Informationen der Methode beschreibt.

Attribute:

Wert: Methodenbeschreibungsfunktion

@ApiParm

Funktion: @ApiParm ist eine Annotation für Methodenparameter. Beschreiben Sie den Parameter.

Attribut:

Name: Parametername

@ApiIgnore

作用：@ApiParm是方法或者参数的注解。忽略注解的方法或者参数，不生成帮助文档

@ApiImplicitParam(常用)

作用：@ApiParm是作用于类上方法，用来描述方法参数的注解。

属性：

name：参数名称，和方法的参数一致

value：参数具体描述

required：值为boolean类型，表示该参数是否为必要参数，默认为false

paramType：参数类型

paramType="字符串"
paramType = "header"

dataType：数据类型

dataType = "string"  //字符串数据
dataType = "键值对"

@ApiImplicitParams

后面跟@ApiImplicitParam的集合，一般用于多个参数的描述

@ApiImplicitParams({@ApiImplicitParam(name = "Authorization", value = "Authorization token", required = true, dataType = "string", paramType = "header")})

@ApiModel(常用)

作用：@ApiModel是作用于实体类上，描述一个实体类型，整个实体类型如果成为任何一个生成api帮助文档的返回对象的时候，该注解被解析

属性：

value：实体类名称

description：实体类描述

@ApiModelProperty(常用)

作用：@ApiModel是作用于实体类的属性上，描述实体类属性

属性：

value：实体属性描述

name：实体类属性名字，与属性名一致

Das obige ist der detaillierte Inhalt vonVerwendung von Swagger2 und Erklärung der Annotation im SpringBoot-Projekt. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!