介绍

记录SpringBoot从零到实现一整个商城后端的过程。

项目组成及技术栈

• 接口 SpingBoot + JPA + mySql
• 后台 vue + vue-element-admin
• 移动端 uniapp + colorui + vuex + scss

备注

搭建springboot项目就不介绍了，直接从项目通用功能开始记录，swagger文档自动化，jwt用户认证

swagger接口文档自动化

导入pom依赖

<dependency>
  	<groupId>io.springfox</groupId>
  	<artifactId>springfox-swagger2</artifactId>
  	<version>2.9.2</version>
</dependency>
<dependency>
	<groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.8.2</version>
</dependency>

创建配置文件

SwaggerConfig

package com.smxy.mall.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .globalOperationParameters(getGlobalOperationParameters()) //全局参数
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.smxy.mall.controller"))  //扫描项目所有的controller
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    private List<Parameter> getGlobalOperationParameters() {
        List<Parameter> pars = new ArrayList<>();
        ParameterBuilder parameterBuilder = new ParameterBuilder();
        // 添加header参数，为了测试方便，添加一个默认token
        parameterBuilder.name("token")
                .defaultValue("eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0eXBlIjoiMiIsInVzZXJJZCI6MzIsInBob25lIjoiMTU3MTYwMjIzOTMiLCJzdWIiOiIzMiIsImlzcyI6IjA5OGY2YmNkNDYyMWQzNzNjYWRlNGU4MzI2MjdiNGY2IiwiaWF0IjoxNTk2MDgwODQ1LCJhdWQiOiJyZXN0YXBpdXNlciIsImV4cCI6MTU5NjY4NTY0NSwibmJmIjoxNTk2MDgwODQ1fQ.RaMy_L0Sa3UKFG7L7iDvmX47dAfrwEocQO7lJKDux8U")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false);
        pars.add(parameterBuilder.build());
        return pars;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")
                .description("springboot+vue")
                .version("1.0")
                .contact(new Contact("帅小黑x","blog.csdn.net","aaa@gmail.com"))
                .license("The Apache License")
                .licenseUrl("http://www.baidu.com")
                .build();
    }

}

访问

项目端口+/doc.html 例如： http://localhost:8083/doc.html