Inhaltsverzeichnis
basePackage(): Geben Sie später die spezifische Adresse des Paketnamens ein, und die Anmerkungen des geänderten Pakets und seiner Unterpakete werden gescannt
@ApiIgnore
@ApiImplicitParam(常用)
@ApiImplicitParams
@ApiModel(常用)
@ApiModelProperty(常用)
Heim Java javaLernprogramm Verwendung von Swagger2 und Erklärung der Annotation im SpringBoot-Projekt

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

May 17, 2023 am 09:40 AM
springboot swagger2

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

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

    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

    Verwendung von Swagger2 und Erklärung der Annotation im SpringBoot-ProjektapiInfo(): 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>
    Nach dem Login kopieren

    contact(): Konfigurieren Sie den Hauptinhalt des Swagger-Dokuments, das auch ein Klassenobjekt ist. Das Klassenobjekt kann bis zu drei Parameter haben: Verwendung von Swagger2 und Erklärung der Annotation im SpringBoot-ProjektPublisher-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 Verwendung von Swagger2 und Erklärung der Annotation im SpringBoot-Projekt

    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>
    Nach dem Login kopieren
    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

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

    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

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

    @ApiIgnore

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

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

    @ApiImplicitParam(常用)

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

    属性

    name:参数名称,和方法的参数一致

    value:参数具体描述

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

    paramType:参数类型

    paramType="字符串"
    paramType = "header"
    Nach dem Login kopieren

    dataType:数据类型

    dataType = "string"  //字符串数据
    dataType = "键值对"
    Nach dem Login kopieren

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

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

    @ApiImplicitParams

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

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

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

    @ApiModel(常用)

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

    属性

    value:实体类名称

    description:实体类描述

    @ApiModelProperty(常用)

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

    属性

    value:实体属性描述

    name:实体类属性名字,与属性名一致

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

    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!

    Erklärung dieser Website
    Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn

    Heiße KI -Werkzeuge

    Undresser.AI Undress

    Undresser.AI Undress

    KI-gestützte App zum Erstellen realistischer Aktfotos

    AI Clothes Remover

    AI Clothes Remover

    Online-KI-Tool zum Entfernen von Kleidung aus Fotos.

    Undress AI Tool

    Undress AI Tool

    Ausziehbilder kostenlos

    Clothoff.io

    Clothoff.io

    KI-Kleiderentferner

    AI Hentai Generator

    AI Hentai Generator

    Erstellen Sie kostenlos Ai Hentai.

    Heißer Artikel

    R.E.P.O. Energiekristalle erklärten und was sie tun (gelber Kristall)
    2 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌
    Repo: Wie man Teamkollegen wiederbelebt
    1 Monate vor By 尊渡假赌尊渡假赌尊渡假赌
    Hello Kitty Island Abenteuer: Wie man riesige Samen bekommt
    4 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌

    Heiße Werkzeuge

    Notepad++7.3.1

    Notepad++7.3.1

    Einfach zu bedienender und kostenloser Code-Editor

    SublimeText3 chinesische Version

    SublimeText3 chinesische Version

    Chinesische Version, sehr einfach zu bedienen

    Senden Sie Studio 13.0.1

    Senden Sie Studio 13.0.1

    Leistungsstarke integrierte PHP-Entwicklungsumgebung

    Dreamweaver CS6

    Dreamweaver CS6

    Visuelle Webentwicklungstools

    SublimeText3 Mac-Version

    SublimeText3 Mac-Version

    Codebearbeitungssoftware auf Gottesniveau (SublimeText3)

    Wie Springboot Jasypt integriert, um die Verschlüsselung von Konfigurationsdateien zu implementieren Wie Springboot Jasypt integriert, um die Verschlüsselung von Konfigurationsdateien zu implementieren Jun 01, 2023 am 08:55 AM

    Einführung in Jasypt Jasypt ist eine Java-Bibliothek, die es einem Entwickler ermöglicht, seinem Projekt mit minimalem Aufwand grundlegende Verschlüsselungsfunktionen hinzuzufügen und kein tiefes Verständnis der Funktionsweise der Verschlüsselung erfordert. standardbasierte Verschlüsselungstechnologie. Passwörter, Text, Zahlen, Binärdateien verschlüsseln ... Geeignet für die Integration in Spring-basierte Anwendungen, offene API, zur Verwendung mit jedem JCE-Anbieter ... Fügen Sie die folgende Abhängigkeit hinzu: com.github.ulisesbocchiojasypt-spring-boot-starter2 Die Vorteile von Jasypt schützen unsere Systemsicherheit. Selbst wenn der Code durchgesickert ist, kann die Datenquelle garantiert werden.

    So implementieren Sie verteilte Sperren mit Redis in SpringBoot So implementieren Sie verteilte Sperren mit Redis in SpringBoot Jun 03, 2023 am 08:16 AM

    1. Redis implementiert das Prinzip der verteilten Sperren und warum verteilte Sperren erforderlich sind. Bevor über verteilte Sperren gesprochen wird, muss erläutert werden, warum verteilte Sperren erforderlich sind. Das Gegenteil von verteilten Sperren sind eigenständige Sperren. Wenn wir Multithread-Programme schreiben, vermeiden wir Datenprobleme, die durch den gleichzeitigen Betrieb einer gemeinsam genutzten Variablen verursacht werden. Normalerweise verwenden wir eine Sperre, um die Richtigkeit der gemeinsam genutzten Variablen sicherzustellen Die gemeinsam genutzten Variablen liegen im gleichen Prozess. Wenn es mehrere Prozesse gibt, die gleichzeitig eine gemeinsam genutzte Ressource betreiben müssen, wie können sie sich dann gegenseitig ausschließen? Heutige Geschäftsanwendungen sind in der Regel Microservice-Architekturen, was auch bedeutet, dass eine Anwendung mehrere Prozesse bereitstellen muss. Wenn mehrere Prozesse dieselbe Datensatzzeile in MySQL ändern müssen, ist eine Verteilung erforderlich, um fehlerhafte Daten zu vermeiden wird zu diesem Zeitpunkt eingeführt. Der Stil ist gesperrt. Punkte erreichen wollen

    Wie SpringBoot Redisson integriert, um eine Verzögerungswarteschlange zu implementieren Wie SpringBoot Redisson integriert, um eine Verzögerungswarteschlange zu implementieren May 30, 2023 pm 02:40 PM

    Nutzungsszenario 1. Die Bestellung wurde erfolgreich aufgegeben, die Zahlung erfolgte jedoch nicht innerhalb von 30 Minuten. Die Zahlung ist abgelaufen und die Bestellung wurde automatisch storniert. 2. Die Bestellung wurde unterzeichnet und es wurde 7 Tage lang keine Bewertung durchgeführt. Wenn die Bestellung abläuft und nicht ausgewertet wird, wird die Bestellung standardmäßig positiv bewertet. Wenn der Händler die Bestellung innerhalb von 5 Minuten nicht erhält, wird die Bestellung abgebrochen Es wird eine SMS-Erinnerung gesendet ... Für Szenarien mit langen Verzögerungen und geringer Echtzeitleistung können wir die Aufgabenplanung verwenden, um eine regelmäßige Abfrageverarbeitung durchzuführen. Zum Beispiel: xxl-job Heute werden wir auswählen

    So lösen Sie das Problem, dass Springboot nach dem Einlesen in ein JAR-Paket nicht auf die Datei zugreifen kann So lösen Sie das Problem, dass Springboot nach dem Einlesen in ein JAR-Paket nicht auf die Datei zugreifen kann Jun 03, 2023 pm 04:38 PM

    Springboot liest die Datei, kann aber nach dem Packen in ein JAR-Paket nicht auf die neueste Entwicklung zugreifen. Es gibt eine Situation, in der Springboot die Datei nach dem Packen in ein JAR-Paket nicht lesen kann ist ungültig und kann nur über den Stream gelesen werden. Die Datei befindet sich unter resources publicvoidtest(){Listnames=newArrayList();InputStreamReaderread=null;try{ClassPathResourceresource=newClassPathResource("name.txt");Input

    Vergleich und Differenzanalyse zwischen SpringBoot und SpringMVC Vergleich und Differenzanalyse zwischen SpringBoot und SpringMVC Dec 29, 2023 am 11:02 AM

    SpringBoot und SpringMVC sind beide häufig verwendete Frameworks in der Java-Entwicklung, es gibt jedoch einige offensichtliche Unterschiede zwischen ihnen. In diesem Artikel werden die Funktionen und Verwendungsmöglichkeiten dieser beiden Frameworks untersucht und ihre Unterschiede verglichen. Lassen Sie uns zunächst etwas über SpringBoot lernen. SpringBoot wurde vom Pivotal-Team entwickelt, um die Erstellung und Bereitstellung von Anwendungen auf Basis des Spring-Frameworks zu vereinfachen. Es bietet eine schnelle und einfache Möglichkeit, eigenständige, ausführbare Dateien zu erstellen

    Wie SpringBoot Redis anpasst, um die Cache-Serialisierung zu implementieren Wie SpringBoot Redis anpasst, um die Cache-Serialisierung zu implementieren Jun 03, 2023 am 11:32 AM

    1. Passen Sie den RedisTemplate1.1-Standard-Serialisierungsmechanismus an. Die API-basierte Redis-Cache-Implementierung verwendet die RedisTemplate-Vorlage für Daten-Caching-Vorgänge. Öffnen Sie hier die RedisTemplate-Klasse und zeigen Sie die Quellcodeinformationen der Klasse publicclassRedisTemplateextendsRedisAccessorimplementsRedisOperations an. Schlüssel deklarieren, verschiedene Serialisierungsmethoden des Werts, der Anfangswert ist leer @NullableprivateRedisSe

    So implementieren Sie Springboot+Mybatis-plus, ohne SQL-Anweisungen zum Hinzufügen mehrerer Tabellen zu verwenden So implementieren Sie Springboot+Mybatis-plus, ohne SQL-Anweisungen zum Hinzufügen mehrerer Tabellen zu verwenden Jun 02, 2023 am 11:07 AM

    Wenn Springboot + Mybatis-plus keine SQL-Anweisungen zum Hinzufügen mehrerer Tabellen verwendet, werden die Probleme, auf die ich gestoßen bin, durch die Simulation des Denkens in der Testumgebung zerlegt: Erstellen Sie ein BrandDTO-Objekt mit Parametern, um die Übergabe von Parametern an den Hintergrund zu simulieren dass es äußerst schwierig ist, Multi-Table-Operationen in Mybatis-plus durchzuführen. Wenn Sie keine Tools wie Mybatis-plus-join verwenden, können Sie nur die entsprechende Mapper.xml-Datei konfigurieren und die stinkende und lange ResultMap konfigurieren Schreiben Sie die entsprechende SQL-Anweisung. Obwohl diese Methode umständlich erscheint, ist sie äußerst flexibel und ermöglicht es uns

    So erhalten Sie den Wert in application.yml in Springboot So erhalten Sie den Wert in application.yml in Springboot Jun 03, 2023 pm 06:43 PM

    In Projekten werden häufig einige Konfigurationsinformationen benötigt. Diese Informationen können in der Testumgebung und in der Produktionsumgebung unterschiedliche Konfigurationen haben und müssen möglicherweise später basierend auf den tatsächlichen Geschäftsbedingungen geändert werden. Wir können diese Konfigurationen nicht fest im Code codieren. Am besten schreiben Sie sie in die Konfigurationsdatei. Sie können diese Informationen beispielsweise in die Datei application.yml schreiben. Wie erhält oder verwendet man diese Adresse im Code? Es gibt 2 Methoden. Methode 1: Wir können den Wert, der dem Schlüssel in der Konfigurationsdatei (application.yml) entspricht, über den mit @Value versehenen Wert erhalten. Diese Methode eignet sich für Situationen, in denen es relativ wenige Mikrodienste gibt: Tatsächlich Projekte, wenn das Geschäft kompliziert ist, Logik

    See all articles