Spring-Boot搭建的后台管理系统笔记

[chengfengjie]

项目基本目录结构

RootDir
│
├──api  #提供给外部系统访问的API
│   
├──backend  #后台系统需要访问的API接口
│
├──business  #业务层，数据访问等核心业务，api、backend、job会调用
│
├──config  #通用配置
│
├──core  #核心层，其他所有项目都会依赖这一层
│
├──frontend  #系统的前台页面
│
├──job  #一些定时任务
│
├──package.json  #整个项目用npm管理
│
├──pom.xml  #项目用到的库用maven管理
│
├──README.md  #项目说明文件

[chengfengjie]

Swagger 发布项目Api文档

一、项目中添加maven依赖

/// swagger 版本号2.6.1
<properties>
   <swagger2.version>2.6.1</swagger2.version>
</properties>

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>${swagger2.version}</version>
</dependency>
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>${swagger2.version}</version>
</dependency>

二、swagger配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket testApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .host(SpringUtil.managerHostPublic())
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("huijinhang.hms.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger 标题")
                .version("版本")
                .build();
    }

}

[chengfengjie]

lombok 自动生成getter和setter方法