grain-Edu-Note part01 Swagger2

个性化时间格式

    @ApiModelProperty(value = "入驻时间")
    @JsonFormat(timezone = "GMT+8",pattern = "yyyy-MM-dd")//个性化时间格式
    private Date joinDate;

使用Swagger

导入Swagger依赖

父模块的依赖管理

        <swagger.version>2.7.0</swagger.version>

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

正式导入依赖

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>

基本配置

这里将Api分为两组

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                        .groupName("webApi")
                        .apiInfo(webApiInfo())
                        .select()
                        .paths(Predicates.and(PathSelectors.regex("/api/.*")))
                        .build();
    }
    @Bean
    public Docket adminApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi")
                .apiInfo(adminApiInfo())
                .select()
                .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                .build();
    }

    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("网站的API文档")
                .description("本文档用于描述谷粒教育网站的api接口定义")
                .version("1.0")
                .contact(new Contact("Ezerbel","http://ezerbel.com","ezerbelcn@gmail.com"))
                .build();
    }

    private ApiInfo adminApiInfo(){
        return new ApiInfoBuilder()
                .title("网站后台的API文档")
                .description("本文档用于描述谷粒教育后台管理的api接口定义")
                .version("1.0")
                .contact(new Contact("Ezerbel","http://ezerbel.com","ezerbelcn@gmail.com"))
                .build();
    }
}

控制器注释

@Api(description = "讲师管理Controller")
@RestController
@RequestMapping("/admin/edu/teacher")
public class TeacherController {

    @Autowired
    private TeacherService teacherService;

    @ApiOperation("所有讲师信息列表")
    @GetMapping("list")
    public List<Teacher> listAll(){
        List<Teacher> list = teacherService.list();
        return list;
    }

    @ApiOperation(value = "根据ID删除讲师",notes = "根据ID删除讲师，逻辑删除")
    @DeleteMapping("remove/{id}")
    public boolean removeById(@ApiParam("要删除的讲师ID") @PathVariable String id){
        return teacherService.removeById(id);
    }
}

测试