swagger2中怎么构建RestfulAPI，很多新手对此不是很清楚，为了帮助大家解决这个难题，下面小编将为大家详细讲解，有这方面需求的人可以来学习下，希望你能有所收获。

双城ssl适用于网站、小程序/APP、API接口等需要进行数据传输应用场景，ssl证书未来市场广阔！成为成都创新互联的ssl证书销售渠道，可以享受市场价格4-6折优惠！如果有意向欢迎电话联系或者加微信：13518219792（备注：SSL证书合作）期待与您的合作！

在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@Configurationpublic 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中怎么构建RestfulAPI
分享地址：http://chengdu.cdxwcx.cn/article/jssogp.html