03上课笔记--Swagger

Swagger

1、使用：

1. 导入pom依赖

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

1. 复制配置类

@Configuration //配置类
@EnableSwagger2 //swagger注解
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();

    }

    private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()
                .title("网站-课程中心API文档")
                .description("本文档描述了课程中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("java", "http://hong.jun", "[e-mail]"))
                .build();
    }
}

1. 输入网址
   ​​​http://localhost:8080/swagger-ui.html​​会显示Controller类。

2、关于数组传递方式–Map

Controller:

/*
    * 传递数组
    * */
@GetMapping("/arr")
@ResponseBody
public Map<String ,Object> getarr(Integer[] num,String[] str){
    Map<String,Object> paramMap=new HashMap<>();
    paramMap.put("numarr",num);
    paramMap.put("strarr",str);
    return paramMap;
}

swagger