SpringBoot integriert Swagger2 Schritte

 1, das Hinzufügen einer Abhängigkeit: die erste Swagger2 Abhängigkeit in pom.xml hinzuzufügen:

<! - Prahlerei依赖-> 
< Abhängigkeit > 
    < groupId > io.springfox </ groupId > 
    < artifactId > springfox-swagger2 </ artifactId > 
    < Version > 2.6.1 </ version > 
</ Abhängigkeit > 
<! - 用于生成在线文档的-> 
< Abhängigkeit > 
    < groupId > io.springfox </ groupId > 
    < artifactId >springfox-Prahlerei-ui </artifactId > 
    < Version > 2.6.1 </ version > 
</ Abhängigkeit >

2 Beschreibung der Controller-Klasse:

　　(1), eine einfache Entity-Klasse zum Speichern von Daten zu erstellen:

public  class Buch {
     // 属性
    private Integer bieten;
    Privater String bname;
    Privater String bprotagonist;
    Privater String AkTyp;
    
    public Buch () {
         Super ();
    }
    public Book (Integer Gebot, String bname, String bprotagonist, String AkTyp) {
         Super ();
        diese .BID = Gebot;
        diese .bname = bname;
        dieser .bprotagonist = bprotagonist;
        dieser .btype = AkTyp;
    }
    public Integer getBid () {
         return Gebot;
    }
    public  Leere setBid (Integer bid) {
         dieses .BID = Gebot;
    }
    public String getBname () {
         return bname;
    }
    öffentliche  Leere setBname (String bname) {
         diese .bname = bname;
    }
    public String getBprotagonist () {
         return bprotagonist;
    }
    öffentliche  Leere setBprotagonist (String bprotagonist) {
         diese .bprotagonist = bprotagonist;
    }
    public String getBtype () {
         return AkTyp;
    }
    öffentliche  Leere setBtype (String AkTyp) {
         diese .btype = AkTyp;
    }
    @Override
    public String toString () {
         return "Buch [Gebot =" + Gebot + "bname =" + bname + "bprotagonist =" + bprotagonist + "AkTyp =" + AkTyp + "]" ;
    }
}

　　(2) Schaffung eines einfachen Controller zum Simulieren Daten zeigen die Wirkung:

/ **
 * Controller-Klasse
 * /
@RestController
public  class BookController {
     / **
     * Holen Sie sich alle Daten
     * / 
    @GetMapping ( "/ get" )
     public List <Book> getBook () {
        Liste <Book> Bücher = neue Arraylist <> ();
        books.add ( neues neues Buch (1, "Garten - Baby", "wow Karte", "Cartoon" ));
        books.add ( neu neues Buch (2, "gebrochen Himmel", "Xiao-yan", "Roman" ));
        books.add ( neues neues Buch (1, "Qingyu Jahre", "Freilandhaltung", "Fiktion" ));
         return Bücher;
    }
    / **
     * Add
     * @Param Buch
     * @Return 
     * / 
    @GetMapping ( "/ add" )
     public Buch AddBook (Buch Buch) {
         return Buch;
    }
    
}

3 hergestellt Swagger2 Konfigurationsklasse, die Scan-Controller SpringMVC:

　　Die meisten der Konfigurationscode in der Klasse festgelegt ist, aber beachten Sie, dass der Controller sein kann empfohlen nicht falsch Paketnamen, kopiert STRG + SHITF + O {} Verknüpfung automatisch die benötigten Pakete vorstellen:

/ **
 * Swagger2 Konfigurationsklasse
 * / 
@Configuration     // als Konfigurationsklasse bezeichnet 
@ EnableSwagger2 // für auf die Boot - Klasse auch geschrieben Swagger2 App aktivieren 
öffentliche  Klasse Swagger2Config {
    
    @Bohne
    public Docket No. createRestApi () {
         // Abtaststeuerung Swagger2 die Anmerkung, .apis , die das angegebene Paket bezeichnen 
        return  new new Docket No. (DocumentationType.SWAGGER_2)
                .apiInfo (apiInfo ())
                .Select ()                       　　　　　　// Paketnamen des Regler                 
                .apis (RequestHandlerSelectors.basePackage ( "com.szc.controller" ))
                .paths (PathSelectors.any ())
                .bauen();
    }

    // die API - Beschreibung 
    Privat ApiInfo apiInfo () {
         Rückkehr  new new ApiInfoBuilder ()
                .title ( "SprignBoot Integration sawgger2 Online - API - Dokumentation")   // Titel 
                .beschreibung ( "Informationen für das Dokument")   // Beschreibung 
                .termsOfServiceUrl ( "https://baidu.com")   // URL 
                .version ( „szc_1. 0 „)   // Version 
                .build ();
    }

}

4, starten SpringBoot Projekt in App Startklasse:

5, nach dem erfolgreichen Start in der Browser - Adressleiste, geben Sie http: // localhost: 8080 / Swagger-ui.html , können Sie sehen die

 siehe den Namen der Steuerung öffnen, können Sie die Art und Weise der

 die Schicht für Schicht Methode öffnen, kann auch ein Verfahren, die gewünschten Parameter oder Rückgabedaten anzuzeigen