swagger整合springboot

1.pom文件中添加依赖

    <dependency>

        <groupId>io.springfox</groupId>

        <artifactId>springfox-swagger2</artifactId>

    </dependency>

 

    <dependency>

        <groupId>io.springfox</groupId>

        <artifactId>springfox-swagger-ui</artifactId>

    </dependency>

    

2.在你的Application.java（即启动类）的同级包下创建swagger2的配置类

    @Configuration

    @EnableSwagger

    public class SwaggerConfig(){

        @Bean

        public Docket alipayApi(){

            return new Docket(DocumentationType.SWAGGER_2)

                                .groupName("支付宝API接口文档")

                                .apiInfo(apiInfo())

                                .select()

                                .apis(RequestHandlerSelectors.basePackage("com.heming.models.alipay"))

                                .paths(PathSelectors.any()).build();

        }

        

        private ApiInfo apiInfo(){

            return new ApiInfoBuilder()

                                .title("支付系统")

                                .description("微信，支付宝，银联支付服务")

                                .termsOfServiceUrl("http://heming.com ")

                                .contact(new Contact("啦啦啦","http://heming.com"))

                                .version("v1.1.1.1.1")

                                .build();

        }

    

    }

 

3.在项目中添加api注解，先了解下这些注解的功能

      1）.swagger2注解使用说明：

         @Api：用在类上，说明该类的作用

         @ApiOperation：用在方法上，说明方法的作用

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

         @ApiImplicitParams：用在方法上包含一组参数说明

         @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面

            paramType：参数放在哪个地方

                 header-->请求参数的获取：@RequestHeader

                 query-->请求参数的获取：@RequestParam

                 path（用于restful接口）-->请求参数的获取：@PathVariable

                 body（不常用）

                 form（不常用）

             name：参数名

             dataType：参数类型

             required：参数是否必须传

             value：参数的意思

             defaultValue：参数的默认值

         @ApiResponses：用于表示一组响应

         @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

             code：数字，例如400

             message：信息，例如"请求参数没填好"

             response：抛出异常的类

         @ApiModel：描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）

         @ApiModelProperty：描述一个model的属性

        2).在类中添加注解

            @Api(value="银联支付"，tags="银联支付接口")

            @Controller

            @RequestMapping(Value="unionpay")

            public class UnionPayController{

                @ApiOperation(value="电脑支付")

                @RequestMapping(value="pcPay",method=RequestMethod.POST)

                @ApiImplicitParam(name="product",value="产品信息",required=true,dataType="String")

                public String pcPay(String product,ModeMap map){

                    System.out.print("没有具体实现，只是为了让你看个ui界面"):

                }

             }

    4.启动项目后，访问地址： http://localhost:8080/swagger-ui.html

       根据你的配置可能是它：http://localhost:8080/你的项目名/swagger-ui.html