Maison > Java > javaDidacticiel > Comment mettre à jour la configuration de Springboot Swagger3

Comment mettre à jour la configuration de Springboot Swagger3

WBOY
Libérer: 2023-05-27 20:30:03
avant
1079 Les gens l'ont consulté

1. Introduire des dépendances, une seule est introduite pour la version 3.0.0

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
Copier après la connexion

2. Classe de configuration SwaggerConfig

package org.fh.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * 说明:Swagger 接口API生成
 * 作者:FH Admin
 * from fhadmin.cn
 */
@Configuration
@EnableOpenApi
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("org.fh.controller"))    // 为当前包路径
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("FH Admin Swagger3 RESTful API")     // 页面标题
                .version("3.0")                                // 版本号
                .description("fhadmin.org")                    // 描述
                .build();
    }

}
Copier après la connexion

3.Configuration d'interception Swagger

.
package org.fh.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 说明:Swagger 拦截配置
 * 作者:FH Admin
 * from fhadmin.cn
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.
                addResourceHandler("/swagger-ui/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/")
                .resourceChain(false);
    }

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/swagger-ui/")
                .setViewName("forward:/swagger-ui/index.html");
    }
}

4.访问 127.0.0.1:8081/swagger-ui/index.html

5.接口说明案例

处理类上加注解,比如
@Api("用户注册登录接口")

在方法上加注解,比如
@ApiOperation(value = "登录", notes="校验登录是否成功")
@ApiImplicitParam(name = "KEYDATA", value = "用户名密码混淆码组合", paramType = "query", required = true, dataType = "String")
Copier après la connexion

Module Workflow---------------------------------www.fhadmin.cn

#🎜 🎜#1. Gestion de modèles : concepteur de processus Web en ligne, importation et exportation XML, processus de copie, processus de déploiement

2. sur les instances de processus Modèle de processus, suspension d'activation

3. Processus en cours : afficher les informations sur le processus, le nœud de tâche actuel, l'organigramme actuel, le processus d'annulation et de pause, affecter une personne à faire, un saut libre

#🎜 🎜#4. Processus historique : afficher les informations sur le processus, la durée du processus, l'état du processus, afficher les informations sur l'initiateur de la tâche

5. Rejetez, invalidez et affectez un agent

6. Tâches effectuées : vérifiez les tâches que vous avez traitées, ainsi que les informations sur le processus, les organigrammes et l'état du processus (l'annulation et le rejet se terminent normalement)#🎜 🎜##🎜🎜 #Lors du traitement des tâches, vous pouvez sélectionner les utilisateurs à copier, ce qui consiste à envoyer un message sur le site à la personne copiée pour notifier les avis et remarques d'approbation actuels

Remarque : lorsque le la tâche en cours est terminée, la prochaine tâche à effectuer Les notifications de nouvelles tâches seront reçues par messagerie instantanée Lorsque la tâche est annulée ou terminée,

l'initiateur de la tâche recevra une notification par message sur le site#🎜. 🎜#

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Étiquettes associées:
source:yisu.com
Déclaration de ce site Web
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn
Tutoriels populaires
Plus>
Derniers téléchargements
Plus>
effets Web
Code source du site Web
Matériel du site Web
Modèle frontal