springboot + vue前后端分离后台管理系统(三)

前言

对于开发人员来说,在开发过程中得自测是不可避免得,像postman这种工具就对模拟http请求提供了便捷。还有就是接口文档也是令人头疼得事情,Swagger就很好得解决了这种事情。

什么是Swagger?

Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset. Find out how Swagger can help you design and document your APIs at scale.
借助Swagger开源和专业工具集,为用户,团队和企业简化API开发。了解Swagger如何帮助您大规模设计和记录API。

Swagger选用

因为Swagger官方的API文档界面不好看,所以就找到了swagger-bootstrap-ui,界面好看还可以自定义请求参数文档。 后来又找到了该团队开发的springboot版本,在原有的基础上增强,Get it !
官网文档地址:https://doc.xiaominfo.com/kni...

image.png

引入

        
        
            com.github.xiaoymin
            knife4j-spring-boot-starter
            2.0.8
        

3.x版本引用的是springfox3和OpenAPI3规范,目前是不稳定版本,所以选择引用2.x的版本~~~~

配置

新建SwaggerConfig.java

@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {

    @Bean(value = "api")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .description("# 文档的描述")
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("1.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.ify.sampleAdmin.web.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

使用

运行http://localhost:8181/sa/doc.html
image.png





待续

你可能感兴趣的:(swagger,springboot,java)