Cet article présente un exemple d'utilisation de Swagger2 dans Spring Boot Project. Il est partagé avec vous. Les détails sont les suivants:
Ajouter les dépendances Swagger2
Ajouter les dépendances Swagger2 dans pom.xml
<dependency> <proupId> io.springfox </proupId> <Artifactid> springfox-swagger2 </retifactid> <version> 2.2.2 </ version> </ Dependency> <Dedency> <proupId> io.springfox </proupId> <Artifactid> SpringFox-Swagger-Ui </ArtifActid> <Durstor
Créer une classe de configuration Swagger2
Créez la classe de configuration de Swagger2 Swagger2 au niveau simultané de l'application.java.
import org.springframework.context.annotation.bean; import org.springframework.context.annotation.configuration; importat springfox.documentation.builders.apiinfobuilder; Springfox.Documentation.Service.apiinfo; Importer Springfox.Documentation.spi.DocumenationType; Importer Springfox.Documentation.spring.web.plugins.docket; Importer Springfox.Documentation.swagger2.annotations.enablewagger2; @ concevoir Creater Creat {return nouveau dossier (documentationtype.swagger_2) .apiinfo (apiinfo ()) .select () .apis (requestHandlerselectors.basePackage ("votre propre nom de package d'interface externe")). } private apiinfo apiinfo () {return new apiinfobuilder () .title ("neo4j restful apis") .deScription ("le neo4j restful apis Description /") .termsofServiceUrl ("") .Contact ("li qinghai") .version ("5.0") .build (); }}Ajouter du contenu du document
Après avoir terminé la configuration ci-dessus, le contenu du document peut en fait être produit, mais ces documents sont principalement destinés à la demande elle-même, et la description provient principalement de la dénomination des fonctions et autres fonctions, qui n'est pas conviviale. Nous devons généralement ajouter des instructions pour enrichir le contenu du document.
Importer io.swagger.annotations.api; import io.swagger.annotations.apioperation; import io.swagger.annotations.apiparam; / ** * Contrôleur d'utilisateur système * * @author li Qinghai * * / @ api (value = "Interface utilisateur système", tags = "System Management") UserController {@Autowired Private UserService UserService; / ** * Ajouter l'utilisateur, le registre * * @param LoginName * Connectez-vous au compte * @param nom d'utilisateur * Nom d'utilisateur * @param mot de passe * Mot de passe de connexion * @param roleID * User Role * @return * @Throws ResourceExistSexception * / @apiOperation (Value = "Add utilisateur") @postmapping ("/") public JsonReult Create (@apiparam (Name = "LoGinname") Compte ", obligatoire = true) @RequestParam (obligatoire = true) @Requestbody String LoginName, @apiparam (name =" username ", value =" nom d'utilisateur ", obligatoire = true) @RequestParam (requis = true) @requestbody String username, @apiparam (name =" password "," log dans le mot de passe ", obligatoire = true) @requestParam (requis = Value =" Log dans le mot de passe ", obligatoire = true) @Apiparam (name = "roleId", value = "Numéro de rôle utilisateur", requise = true) @RequestParam (requis = true) @Requestbody String RoleID) lève ResourceExistSException {boolean exists = this.userservice.exists (liginname); if (existant) {lancer un nouveau ressourceExistSException (loginname); } Utilisateur utilisateur = userService.Create (LoginName, Mot de passe, nom d'utilisateur, RoleID); retourner un nouveau jsonResult (utilisateur); }}Afficher l'API
Démarrez le programme Spring Boot et visitez: http: // localhost: 8080 / swagger-ui.html
Accès et débogage des documents API
En plus de visualiser la fonction d'interface, Swagger fournit également des fonctions de débogage et de test. Nous pouvons cliquer sur le schéma du modèle (zone jaune: il indique la structure des données) à droite dans l'image ci-dessus. À l'heure actuelle, il existe un modèle pour l'objet utilisateur dans la valeur. Nous avons seulement besoin de le modifier légèrement, cliquez sur essayer ci-dessous! Bouton, vous pouvez effectuer un appel de demande! Plusieurs demandes de GET peuvent être utilisées pour vérifier que la demande de post précédente est correcte.
Ce qui précède est tout le contenu de cet article. J'espère que cela sera utile à l'apprentissage de tous et j'espère que tout le monde soutiendra davantage Wulin.com.