springboot2.0+swagger集成

2019-01-31 17:01:57 阅读：423 来源： 互联网

标签：集成 swagger springboot2.0 jsonObject documentation return new import springfox

场景:项目中添加Swagger配置，可以加速项目的开发，在快速开发项目中十分重要。

1、pom.xml添加swagger

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.20</version>
        </dependency>

2、添加SwaggerConfig.java文件

/*
 * (C) Copyright 2018 Siyue Holding Group.
 */
package com.mycat.demo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableSwagger2
public class Swagger {
  @Bean
  public Docket createRestApi() {
    ParameterBuilder tokenPar = new ParameterBuilder();
    List<Parameter> pars = new ArrayList<>();
    tokenPar.name("token").description("令牌")
        .modelRef(new ModelRef("string")).parameterType("header").required(false).build();
    pars.add(tokenPar.build());
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.mycat.demo.controller")) #扫描的controller包
        .paths(PathSelectors.any())
        .build().globalOperationParameters(pars)  ;
  }

 /* @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.mycat.demo.controller"))
            .paths(PathSelectors.any())
            .build();
  }*/

  @SuppressWarnings("deprecation")
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Mycat配置测试")
        .description("Mycat微服务 API 文档")
        .contact("Develop Team")
        .version("1.0")
        .build();
  }

}

3、在controller类中添加，@ApiOperation(nickname = "addMember",value="添加用户",httpMethod = "POST")

@RequestMapping("/addMember")
@ApiOperation(nickname = "addMember",value="添加用户",httpMethod = "POST")
@ResponseBody
public JSONObject addMember(HttpServletRequest request, HttpServletResponse response, @RequestBody Member member) {
    JSONObject jsonObject = new JSONObject();
  /*  Member member = new Member();
    member.setName("yangwenjie345");
    member.setAge(20);*/
    int insertNum = memberService.insert(member);
    if(insertNum == 0){
        jsonObject.put("code", CodeEnum.ERROR_CREATE_FAIL.getValue());
        jsonObject.put("message",CodeEnum.ERROR_CREATE_FAIL.getMessage());
        return  jsonObject;
    }
    //查询有结果
    jsonObject.put("code", CodeEnum.SUCCESS.getValue());
    jsonObject.put("message",CodeEnum.SUCCESS.getMessage());
    return  jsonObject;
}

4、启动项目访问

http://localhost:8080/swagger-ui.html

demo的github地址：https://github.com/812406210/springboot2.0-swagger

如有问题，可以留言！

标签：集成,swagger,springboot2.0,jsonObject,documentation,return,new,import,springfox
来源： https://www.cnblogs.com/ywjfx/p/10342661.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

springboot2.0+swagger集成