SpringBoot-Integrate Knife4j

Document officiel: https://doc.xiaominfo.com/knife4j/documentation/description.html

Au début, l'intention initiale du projet était d'écrire une version améliorée de l'interface utilisateur frontale de swagger, mais avec le développement du projet, face à des besoins de plus en plus personnalisés, le code Java back-end avait à écrire pour répondre aux nouveaux besoins, dans swagger- Entre les versions 1.8.5 et 1.9.6 de bootstrap-ui, le code Java back-end et l'interface utilisateur sont mélangés dans un package Jar destiné aux développeurs. pratique pour l'intégration swagger, il vous suffit d'introduire le package jar, mais il est un peu gonflé sous l'architecture du microservice.

Je l'ai essayé, c'est plutôt bon ~~
D'accord, ajoutez un lanceur

 <!--knife4j-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.8</version>
        </dependency>

Ecrivez à nouveau la classe de configuration

@Configuration
@EnableSwagger2WebMvc // 更换注解
public class Knife4jConfiguration {
    
    

    @Bean
    public Docket createRestApi() {
    
    
        ApiInfo apiInfo = new ApiInfoBuilder()
                // 文档标题
                .title("Spring-boot项目")
                //文档描述
                .description("V2.0接口规范")
                //服务条款URL
                .termsOfServiceUrl("http://127.0.0.1:80/")
                //版本号
                .version("2.0.0")
                .build();

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                //是否开启
                .enable(true)
                .select()
                //设置basePackage会将包下的所有被@Api标记类的所有方法作为api
                .apis(RequestHandlerSelectors.basePackage("com.knife4j.demo.controller"))
                //指定路径处理PathSelectors.any()代表所有的路径
                .paths(PathSelectors.any())
                .build();
    }


}

Ensuite, écrivez un commentaire dans le contrôleur

@Controller
@Api(value = "页面接口",description = "跳转接口测试")
public class HelloController {
    
    
    @RequestMapping("/hello")
    @ApiImplicitParam(name = "url",value = "null",required = true)
    @ApiOperation(value = "跳转hello页面")
    public String index(){
    
    
        return "hello";
    }
}

Juste au cas où, ajoutez une annotation @ EnableKnife4j à la classe de
démarrage Startup ... C'est

toujours bon pour le développement, ce qui réduit le temps d'écriture des documents de développement