Si votre entreprise n'a pas utilisé Swagger ou même entendu parler de Swagger, dépêchez-vous et apprenez ce blog, cinq minutes, l'intégration de style imbécile, mais une application aussi simple les choquera sûrement.
Tout d'abord, donnons une brève introduction à Swagger: Swagger est un outil magique pour le développement back-end et un canal pour la communication frontale. Que pouvez-vous faire avec Swagger? Tout d'abord, vous pouvez essentiellement dire au revoir aux tests unitaires à l'avenir; Deuxièmement, vous n'avez plus à rédiger des documents d'interface et vous n'avez pas besoin de maintenir les documents après les avoir écrits. Swagger peut simuler pleinement les demandes HTTP, et la différence entre les paramètres entrants et sortants et les conditions réelles est presque nulle. Cela dit, faisons quelques informations!
Quatre partie intégrée:
Étape 1: Importez deux dépendances. Si vous n'êtes pas un projet Maven, vous pouvez rechercher le package JAR. N'oubliez pas que seuls deux sont nécessaires. J'ai vu que j'en ai présenté sept ou huit dans d'autres tutoriels, ce qui est un gaspillage.
<Dependance> <GroupID> io.springfox </prôdId> <Ertifactid> Springfox-swagger2 </letefactId> <DERVIÈRE> 2.6.1 </ version> </Dependency> <Dependency> <ProupID> io.springfox </prowprid> <ptifactid> SpringFox-Swagger-Ui </Artifactid>
Étape 2: Ajoutez une classe (copiez la suivante, veuillez noter que vous pouvez modifier le nom et l'adresse du package)
/ ** * Configuration de la bagasse .apis (requestHandlerselectors.basepackage ("com.z * .b * .c * .Controller")) // Notez que vous modifiez le nom du package ici.paths (pathSelectors.Any ()) .Build (); } private apiinfo apiinfo () {return new apiinfobuilder () .title ("Liste d'interface v1.1.0") // tout, veuillez le réglementer un peu.description ("test d'interface") // tout, veuillez le réglementer un peu.termsofserviceurl ("http: //url/swagger Votre propre IP: port .Contact ("laowu") // peu importe (voici l'alias de l'auteur) .Version ("1.1.0") .build (); }} Étape 3: Ajoutez la configuration suivante au fichier de configuration MVC. Peut-être que votre fichier peut s'appeler Dispatcher.xml! (Il suffit de copier, aucune modification n'est requise)
<MVC: Ressources Mapping = "Swagger-Ui.html" Location = "ClassPath: / Meta-Inf / Resources /" / >> <MVC: Resources Mapping = "/ webjars / **" Location = "ClassPath: / Meta-Inf / Resources / Webjars /" />
Étape 4: Ajouter des annotations sur les méthodes et les paramètres
Méthode:
@ApiOperation (value = "tutoriel", httpMethod = "post", notes = "tutoriel")
Mettez-le dans le registre:
@Apiparam (obligatoire = true, name = "test", value = "paramètre de tutoriel")
Je crains que certains amis ne comprennent pas très bien, alors mettons une photo!
Étape 5: Démarrez le service et entrez dans le navigateur:
http: // ip: port / swagger-ui.html
L'écran suivant apparaît signifie que la tâche est terminée:
Remarque: Si vous utilisez un intercepteur dans votre projet, veuillez libérer la ressource Swagger (vous pouvez toujours copier la configuration suivante directement, ne doutez pas de v2)
<mvc: excluant le path-mappage = "/ swagger * / **"> </ mvc: exclure-mapping> <mvc: exclure mappant path = "/ v2 / **"> </ mvc: exclure-mapping> <mvc: exclure-mapping path = "
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.