Heim >Java >javaLernprogramm >Detaillierte Einführung in die Verwendung von Swagger in der Java-API-Entwicklung
Swagger ist ein sehr nützliches Tool in der Java-API-Entwicklung. Swagger ist ein Open-Source-API-Framework zum Beschreiben, Entwerfen und Generieren von RESTful-Webdiensten. Es bietet eine Reihe von Anmerkungen, die Entwicklern bei der Beschreibung von APIs und Parametern helfen. In diesem Artikel werde ich detailliert beschreiben, wie Swagger in der Java-API-Entwicklung verwendet wird.
Swagger kann mit Maven in Java-Projekte integriert werden. Sie können Swagger zu Ihrem Projekt hinzufügen, indem Sie die folgenden Maven-Abhängigkeiten verwenden:
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency>
Außerdem müssen Sie die folgenden Abhängigkeiten hinzufügen, um die Swagger-Benutzeroberfläche zu generieren:
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>
in Ihrer Java-Anwendung, die Sie konfigurieren müssen Stolzieren. Dazu können Sie eine Konfigurationsklasse erstellen, um Swagger zu initialisieren:
@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } }
Im obigen Code haben wir eine Docket-Bean definiert, die die Hauptschnittstelle von Swagger darstellt. Wir verwenden dies, um den Typ der Swagger-API anzugeben und ihn der URL der Anwendung zuzuordnen.
Jetzt können Sie Swagger-Anmerkungen in Ihrer Java-API hinzufügen. Im Folgenden sind einige häufig verwendete Swagger-Anmerkungen und ihre Verwendung aufgeführt:
Diese Anmerkungen können auf Klassen, Methoden, Feldern und Methodenparametern platziert werden und können Informationen über API-Kommentare bereitstellen, indem sie die Attribute „value“ und „notes“ verwenden.
Wenn Sie beispielsweise den folgenden Codeausschnitt haben:
@RestController @RequestMapping("/users") public class UserController { @GetMapping("/{id}") public User getUser(@PathVariable Long id) { // code to get user } }
Sie können Swagger-Annotationen verwenden, um die getUser-Methode zu beschreiben:
@RestController @RequestMapping("/users") @Api(value="用户管理", tags="用户管理") public class UserController { @GetMapping("/{id}") @ApiOperation(value="获取用户信息", notes="根据用户ID获取用户信息") @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long") public User getUser(@PathVariable Long id) { // code to get user } }
Im obigen Code haben wir die Annotationen @Api und @ApiOperation verwendet. Die @Api-Annotation wird verwendet, um die gesamte API zu beschreiben, einschließlich Name und Bezeichnung. Die Annotation @ApiOperation wird verwendet, um den Namen des Vorgangs sowie einige Hinweise zum Vorgang zu beschreiben.
Da Ihre Java-Anwendung nun mit Swagger und Swagger-Annotationen konfiguriert ist, können Sie die Swagger-Benutzeroberfläche verwenden, um die API anzuzeigen und zu testen.
Dazu können Sie die folgende Zeile unter der @Bean-Annotation in der SwaggerConfig-Klasse hinzufügen:
@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } @Bean public UiConfiguration uiConfig() { return UiConfigurationBuilder.builder() .docExpansion(DocExpansion.LIST) .build(); } }
Dadurch wird eine uiConfig()-Bean zum Konfigurieren der Swagger-Benutzeroberfläche hinzugefügt. Mit dem obigen Code setzen wir DocExpansion auf LIST, sodass alle Aktionen standardmäßig in der Benutzeroberfläche erweitert werden.
Jetzt haben Sie Swagger und Swagger-Annotationen konfiguriert und die Swagger-Benutzeroberfläche in der SwaggerConfig-Klasse generiert. Sie können die Anwendung mit dem folgenden Befehl starten:
$ mvn spring-boot:run
Gemäß den Standardeinstellungen von Swagger können Sie über den Browser auf die Swagger-Benutzeroberfläche zugreifen. Navigieren Sie zu http://localhost:8080/swagger-ui.html und Sie werden sehen, dass die Swagger-Benutzeroberfläche Ihre API bereits anzeigt.
Abschließend können Sie die Swagger-Benutzeroberfläche verwenden, um die API zu testen. Wenn Sie auf die Schaltfläche „Ausprobieren“ klicken, sendet die Swagger-Benutzeroberfläche automatisch eine Anfrage an Ihre API und Sie sehen die Antwort in der Benutzeroberfläche.
In diesem Artikel habe ich die Verwendung von Swagger in der Java-API-Entwicklung vorgestellt. Mit Swagger können Sie Ihre API einfach beschreiben und testen und eine Dokumentation erstellen, die einfach zu lesen und zu verwenden ist. Wenn Sie ein Java-Entwickler sind, empfehle ich Ihnen, Swagger auszuprobieren, um die API-Entwicklung und das Testen zu vereinfachen.
Das obige ist der detaillierte Inhalt vonDetaillierte Einführung in die Verwendung von Swagger in der Java-API-Entwicklung. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!