SpringBoot集成Swagger2實現(xiàn)Restful(類型轉(zhuǎn)換錯誤解決辦法)

更新時間：2017年07月05日 14:33:15 作者：那小子很拽

這篇文章主要介紹了SpringBoot集成Swagger2實現(xiàn)Restful(類型轉(zhuǎn)換錯誤解決辦法),需要的朋友可以參考下

pom.xml增加依賴包

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

編寫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構(gòu)建的RESTful APIs")
        .description("更多Spring Boot相關(guān)文章請關(guān)注：http://blog.didispace.com/")
        .termsOfServiceUrl("http://blog.didispace.com/")
        .contact("leo")
        .version("1.0")
        .build();
  }
}

Controller內(nèi)使用

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<Long, User> users=Collections.synchronizedMap(new HashMap<Long,User>());
  @ApiOperation(value="獲取用戶列表",notes="")
  @RequestMapping(value={""},method=RequestMethod.GET)
  public List<User> getUserList(){
    List<User> r=new ArrayList<User>(users.values());
    return r;    
  }
   @ApiOperation(value="創(chuàng)建用戶", notes="根據(jù)User對象創(chuàng)建用戶")
    @ApiImplicitParam(name = "user", value = "用戶詳細(xì)實體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="獲取用戶詳細(xì)信息", notes="根據(jù)url的id來獲取用戶詳細(xì)信息")
    @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="更新用戶詳細(xì)信息", notes="根據(jù)url的id來指定更新對象，并根據(jù)傳過來的user信息來更新用戶詳細(xì)信息")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "用戶ID", required = true, paramType="path", dataType = "Long"),
        @ApiImplicitParam(name = "user", value = "用戶詳細(xì)實體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="根據(jù)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” 會提示類型轉(zhuǎn)換String convert to Long錯誤。

以上所述是小編給大家介紹的SpringBoot集成Swagger2實現(xiàn)Restful(類型轉(zhuǎn)換錯誤解決辦法)，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復(fù)大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持！

您可能感興趣的文章: