Explication détaillée de la façon d'utiliser Swaggerui à Springboot

Fanfarner

Swagger est une spécification et un cadre indépendants du langage utilisés pour définir les interfaces de service et est principalement utilisé pour décrire les API RESTful. Il se concentre sur la création d'excellentes bibliothèques de documentation et de clients pour les API. Les API compatibles Swagger peuvent générer des documents interactifs pour les méthodes d'API, permettant aux utilisateurs de découvrir les fonctionnalités de l'API en expérimentant visuellement, en affichant les demandes et les réponses, les fichiers d'en-tête et les codes de retour.

Swagger est utilisé pour définir la documentation de l'API.

avantage:

1. Front et arrière livraison séparée
2. La documentation de l'API est très claire
3. Pendant les tests, vous n'avez plus besoin d'utiliser une entrée d'URL dans le navigateur pour accéder au contrôleur
4. La façon traditionnelle de saisir les URL est plus gênante pour passer des paramètres dans les demandes de poste (bien sûr, vous pouvez utiliser des plug-ins de navigateur comme Postman)
5. L'intégration de Spring-Boot et Swagger est plus simple

Springboot intégré Swaggerui

étape

1.Jar Package Introduction

 <dependency> <proupId> io.springfox </proncId> <Ertifactid> Springfox-Swagger-Ui </Retifactid> <DERSE> 2.2.2 </DERNIERD> <COPE> Compiler </cope> </Dedency> <Dependency> <ProupId> io.springFox </propeD> <ArtifActid> Springfox-Swagger2 </ ArtiFact> <version> 2.2.2 </ version> <ccope> Compiler </ccope> </dependency>

2. Configuration de SwaggerConfig basée sur Springboot

 @ Configuration @ ActivedWagger2Public classe SwaggerConfig {@Bean public Docket Newsapi () {// return nouveau dossier (documentationtype.swagger_2) .apiinfo (apiinfo ()). SELECT (). PATHS (pathselectors.any ()). Build (); Docket docket = nouveau docket (documentationtype.swagger_2); docket.enable (true); docket.apiinfo (apiInfo ()). SELECT (). PATHS (pathSelectors.Any ()). Build (); Dossier de retour; } privé apiinfo apiinfo () {return new ApiInfobuilder (). Title ("Order Center Test Platform"). Description ("Ici, vous pouvez parcourir toutes les interfaces du projet et fournir des outils de test pertinents") .termsofServiceUrl ("http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?open") .Contact ("test") .liquene ("China Red Star License version 1.0"). LicenceUrl ("#"). version ("1.0"). Build (); }}

3. Instructions de configuration WebConfig

Il y a un problème qui doit être prêté attention ici. Laissez WebConfig hériter webmvcautoconfigurationAdapter au lieu de hériter directement de webmvcconfigurerAdapter, sinon la page Swagger ne sera pas publiée.

 @ Configuration @ activerwebmvcpublic class WebConfig étend webmvcautoconFigurationAdapter {@Override public void addCorsMappings (CorsEgistry Registry) {registry.addmapping ("/ **"); } @Bean public static PropertySourcesPlaceHolderConfigurer PropertySourcesPlaceHolderConfigurer () {return new PropertySourcesPlaceHolderConfigurer (); } @Bean Public Filter CharacterEncodingFilter () {CharacterEncodingFilter CharacterEncodingFilter = new CharacterEncodingFilter (); CaracterEncodingFilter.SetEncoding ("UTF-8"); CaracterEncodingFilter.SetForceencoding (true); RETOUR CHARGETENCODODINGFILTER; } @Bean public MappingJackSon2HttpMessageConverter Converter () {MappingJackSon2HttpMessageConverter Converter = new MappingJackSon2HttpMessageConverter (); convertisseur de retour; } @Bean public ViewResolver getViewResolver () {internalresourceViewResolver Resolver = new internalresourceViewResolver (); résolver.setViewClass (jStlView.class); résolver.setPrefix ("/ jsp"); résolver.setsuffix (". jsp"); RETOUR RESOLVER; } @Bean Public StandardServletMultipArtresolver GetstandardervletMultipartreSolver () {return new StandardervletMultipartResolver (); }}

4. Accès de la page Swaggerui

http: // localhost: 8080 / projectName / swagger-Ui.html #! /

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.