pom.xml增加依賴包
1
2
3
4
5
6
7
8
9
10
|
<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配置類
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
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)文章請(qǐng)關(guān)注:http://blog.didispace.com/" ) .termsOfServiceUrl( "http://blog.didispace.com/" ) .contact( "leo" ) .version( "1.0" ) .build(); } } |
Controller內(nèi)使用
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
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對(duì)象創(chuàng)建用戶" ) @ApiImplicitParam (name = "user" , value = "用戶詳細(xì)實(shí)體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來(lái)獲取用戶詳細(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來(lái)指定更新對(duì)象,并根據(jù)傳過(guò)來(lái)的user信息來(lái)更新用戶詳細(xì)信息" ) @ApiImplicitParams ({ @ApiImplicitParam (name = "id" , value = "用戶ID" , required = true , paramType= "path" , dataType = "Long" ), @ApiImplicitParam (name = "user" , value = "用戶詳細(xì)實(shí)體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來(lái)指定刪除對(duì)象" ) @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" ; } } |
如果上訴代碼沒(méi)有寫paramType = “path”
會(huì)提示類型轉(zhuǎn)換String convert to Long
錯(cuò)誤。
以上所述是小編給大家介紹的SpringBoot集成Swagger2實(shí)現(xiàn)Restful(類型轉(zhuǎn)換錯(cuò)誤解決辦法),希望對(duì)大家有所幫助,如果大家有任何疑問(wèn)請(qǐng)給我留言,小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)服務(wù)器之家網(wǎng)站的支持!
原文鏈接:http://blog.csdn.net/haoqi9999/article/details/74421483