宜宾网站建设公司

在SpringBoot中结合Swagger2实现Restful的方法

这期内容当中小编将会给大家带来有关在SpringBoot中结合Swagger2实现Restful的方法，文章内容丰富且以专业的角度为大家分析和叙述，阅读完这篇文章希望大家可以有所收获。

成都创新互联公司专业为企业提供通城网站建设、通城做网站、通城网站设计、通城网站制作等企业网站建设、网页设计与制作、通城企业网站模板建站服务，十多年通城做网站经验，不只是建网站，更提供有价值的思路和整体网络服务。

pom.xml增加依赖包

 
    io.springfox
    springfox-swagger2
    2.2.2
  
  
    io.springfox
    springfox-swagger-ui
    2.2.2

编写swapper2配置类

package com.zyank;
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;
@Configuration
@EnableSwagger2
public class Swagger2 {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.zyank.web"))
        .paths(PathSelectors.any())
        .build();
  }
  private ApiInfo apiInfo(){
    return new ApiInfoBuilder()
        .title("Spring Boot中试用Swagger2构建的RESTful APIs")
        .description("更多Spring Boot相关文章请关注：http://blog.didispace.com/")
        .termsOfServiceUrl("http://blog.didispace.com/")
        .contact("leo")
        .version("1.0")
        .build();
  }
}

Controller内使用

package com.zyank.web;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import com.zyank.domain.User;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
@RestController
@RequestMapping(value="/users")
public class UserContrller {
  static Map users=Collections.synchronizedMap(new HashMap());
  @ApiOperation(value="获取用户列表",notes="")
  @RequestMapping(value={""},method=RequestMethod.GET)
  public List getUserList(){
    List r=new ArrayList(users.values());
    return r;    
  }
   @ApiOperation(value="创建用户", notes="根据User对象创建用户")
    @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
    @RequestMapping(value="", method=RequestMethod.POST)
    public String postUser(@RequestBody User user) {
      users.put(user.getId(), user);
      return "success";
    }
    @ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, paramType="path", dataType = "Long")
    @RequestMapping(value="/{id}", method=RequestMethod.GET)
    public User getUser(@PathVariable Long id) {
      return users.get(id);
    }
    @ApiOperation(value="更新用户详细信息", notes="根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "用户ID", required = true, paramType="path", dataType = "Long"),
        @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
    })
    @RequestMapping(value="/{id}", method=RequestMethod.PUT)
    public String putUser(@PathVariable Long id, @RequestBody User user) {
      User u = users.get(id);
      u.setName(user.getName());
      u.setAge(user.getAge());
      users.put(id, u);
      return "success";
    }
    @ApiOperation(value="删除用户", notes="根据url的id来指定删除对象")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
    @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
    public String deleteUser(@PathVariable Long id) {
      users.remove(id);
      return "success";
    }
}

如果上诉代码没有写paramType = “path” 会提示类型转换String convert to Long错误。

上述就是小编为大家分享的在SpringBoot中结合Swagger2实现Restful的方法了，如果刚好有类似的疑惑，不妨参照上述分析进行理解。如果想知道更多相关知识，欢迎关注创新互联行业资讯频道。


分享名称：在SpringBoot中结合Swagger2实现Restful的方法
文章源于：http://hbruida.cn/article/jhooss.html

其他资讯