[JAVA] Présentez swagger-ui à l'API REST implémentée dans Spring Boot
Aperçu
- Hypothèse que Spring Boot implémente l'API REST --Introduire swagger-ui pour générer la documentation de l'API
- Ajoutez juste ʻio.springfox: springfox-boot-starter: 3.0.0` pour graduer
Exemple de projet
--Créez un nouveau projet en sélectionnant Spring Web dans Spring Initializr
- API REST implémentée --Créez src \ main \ java \ com \ example \ demo \ api \ DemoController.java avec le contenu suivant
package com.example.demo.api;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.Map;
@RestController
@RequestMapping("/api/demo")
public class DemoController {
@GetMapping("/customers")
public String[] customers() {
return new String[] {
"AIUEO",
"Kakikukeko",
"SA Shi Su Se So"
};
}
@GetMapping("/customer/{id}")
public Map<String, String> customer(@PathVariable String id) {
return Map.of(
"id", id,
"name", "Nom",
"address", "Tokyo");
}
}
Swagger-ui introduit
--Ajouté à build.gradle
build.gradle
implementation "io.springfox:springfox-boot-starter:3.0.0"
- Lancement de l'application
--Ouvrez http: // localhost: 8080 / swagger-ui / dans votre navigateur
référence
- https://springfox.github.io/springfox/docs/current/
Recommended Posts