集成swagger2构建RestfulAPI的示例-创新互联

这篇文章给大家分享的是有关集成swagger2构建Restful API的示例的内容。小编觉得挺实用的，因此分享给大家做个参考，一起跟随小编过来看看吧。

为藤县等地区用户提供了全套网页设计制作服务，及藤县网站建设行业解决方案。主营业务为成都做网站、网站制作、藤县网站设计，以传统方式定制建设网站，并提供域名空间备案等一条龙服务，秉承以专业、用心的态度为用户提供真诚的服务。我们深信只要达到每一位用户的要求，就会得到认可，从而选择与我们长期合作。这样，我们也可以走得更远！

在pom.xml中进行版本管理

2.8.0

给taosir-api的pom.xml中添加依赖配置

  io.springfox
  springfox-swagger2
  ${swagger.version}


  io.springfox
  springfox-swagger-ui
  ${swagger.version}

添加配置类

package cn.taosir.api.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@Configuration
public class SwaggerConfiguration {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        //控制暴露出去的路径下的实例
        //如果某个接口不想暴露,可以使用以下注解
        //@ApiIgnore 这样,该接口就不会暴露在 swagger2 的页面下
        .apis(RequestHandlerSelectors.basePackage("cn.taosir.api.controller"))
        .paths(PathSelectors.any())
        .build();
  }
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("涛先森系统入口业务测试")
        .version("1.0")
        .description("API 描述")
        .build();
  }
}

为控制层添加相应注解

package cn.taosir.api.controller.dreamhouse;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import cn.taosir.service.dreamHouse.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
@RestController
@Api(value = "用户管理" ,tags = {"用户的接口"})
public class UserController {
  @Autowired
  private UserService userService;
  
  @ApiOperation(value="测试方法", notes="测试是否成功使用服务发现")
  @RequestMapping(value="/test",method=RequestMethod.GET)
  public String test() {
    return userService.test();
  }
}

按顺序启动

taosir-eureka注册中心

taosir-dreamHouse服务提供者

taoisr-api服务消费者

访问地址 http://localhost:8765/swagger-ui.html#

以上，集成swagger2构建Restful API

下面附上注解参考表

@Api：用在请求的类上，表示对类的说明
  tags="说明该类的作用，可以在UI界面上看到的注解"
  value="该参数没什么意义，在UI界面上也看到，所以不需要配置"
 
@ApiOperation：用在请求的方法上，说明方法的用途、作用
  value="说明方法的用途、作用"
  notes="方法的备注说明"
 
@ApiImplicitParams：用在请求的方法上，表示一组参数说明
  @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
    name：参数名
    value：参数的汉字说明、解释
    required：参数是否必须传
    paramType：参数放在哪个地方
      · header --> 请求参数的获取：@RequestHeader
      · query --> 请求参数的获取：@RequestParam
      · path（用于restful接口）--> 请求参数的获取：@PathVariable
      · body（不常用）
      · form（不常用）  
    dataType：参数类型，默认String，其它值dataType="Integer"    
    defaultValue：参数的默认值
 
@ApiResponses：用在请求的方法上，表示一组响应
  @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
    code：数字，例如400
    message：信息，例如"请求参数没填好"
    response：抛出异常的类
 
@ApiModel：用于响应类上，表示一个返回响应数据的信息
      （这种一般用在post创建的时候，使用@RequestBody这样的场景，
      请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：用在属性上，描述响应类的属性

感谢各位的阅读！关于“集成swagger2构建Restful API的示例”这篇文章就分享到这里了，希望以上内容可以对大家有一定的帮助，让大家可以学到更多知识，如果觉得文章不错，可以把它分享出去让更多的人看到吧！

另外有需要云服务器可以了解下创新互联建站www.cdcxhl.com，海内外云服务器15元起步，三天无理由+7*72小时售后在线，公司持有idc许可证，提供“云服务器、裸金属服务器、高防服务器、香港服务器、美国服务器、虚拟主机、免备案服务器”等云主机租用服务以及企业上云的综合解决方案，具有“安全稳定、简单易用、服务可用性高、性价比高”等特点与优势，专为企业上云打造定制，能够满足用户丰富、多元化的应用场景需求。

网站题目：集成swagger2构建RestfulAPI的示例-创新互联
文章位置：http://cxhlcq.com/article/cogcid.html