【SpringBoot】——SpringBoot整合swagger

补的这篇博客：+++++++++++

      Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持步。Swagger让部署管理和使用功能强大的API从未如此简单。使用swagger可以方便前后端联调，前端根据swagger地址中的参数信息，可以以此来决定前端实体给后端的值等。后端可以简化测试。

配置步骤；

第一步：在pom.xml文件中引入相关的jar包 

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

        第二步：编写swagger的配置类

@Configuration
@EnableSwagger2
public class Swaggers {

        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.davina"))
                    .paths(PathSelectors.any())
                    .build();
        }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("springboot利用swagger构建api文档")
                .description("简单优雅的restfun风格")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }
}

        通过@Configuration注解，表明它是一个配置类，@EnableSwagger2开启swagger2。apiINfo()配置一些基本的信息。apis()指定扫描的包会生成文档。

        第三步：编写测试类

@RestController
@RequestMapping("/hello")
public class HelloController {

    @Autowired
    private GirlProperties girlProperties;

    /**
     * 测试方法
     */
    @ApiOperation(value="返回一个id", notes="返回一个id")
    @ApiImplicitParam(name = "id", value = "ID", required = true, dataType = "Integer",paramType = "path")
    @RequestMapping(value = {"/say"},method = RequestMethod.GET)
    public String say(@RequestParam(value = "id",required=false,defaultValue = "0")Integer myId){
        return "id:"+myId;

    }
}

        

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。

 

@Api：修饰整个类，描述Controller的作用

@ApiOperation：描述一个类的一个方法，或者说一个接口

@ApiParam：单个参数描述

@ApiModel：用对象来接收参数

@ApiProperty：用对象接收参数时，描述对象的一个字段

@ApiResponse：HTTP响应其中1个描述

@ApiResponses：HTTP响应整体描述

@ApiIgnore：使用该注解忽略这个API

@ApiError：发生错误返回的信息

@ApiParamImplicitL：一个请求参数

@ApiParamsImplicit多个请求参数

第四步：Application载入类      

@SpringBootApplication
public class GirlApplication {

	public static void main(String[] args) {
		SpringApplication.run(GirlApplication.class, args);
	}
}