介绍
这期内容当中小编将会给大家带来有关在SpringBoot中结合Swagger2实现Restful的方法,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。
砰的一声。xml增加依赖包
& lt; dependency> & lt; groupId> io.springfox & lt; artifactId> springfox-swagger2 & lt; version> 2.2.2 & lt;/dependency> & lt; dependency> & lt; groupId> io.springfox & lt; artifactId> springfox-swagger-ui & lt; version> 2.2.2 & lt;/dependency>
编写swapper2配置类
包com.zyank;
进口org.springframework.context.annotation.Bean;
进口org.springframework.context.annotation.Configuration;
进口springfox.documentation.builders.ApiInfoBuilder;
进口springfox.documentation.builders.PathSelectors;
进口springfox.documentation.builders.RequestHandlerSelectors;
进口springfox.documentation.service.ApiInfo;
进口springfox.documentation.spi.DocumentationType;
进口springfox.documentation.spring.web.plugins.Docket;
进口springfox.documentation.swagger2.annotations.EnableSwagger2;
@ configuration
@EnableSwagger2
公开课Swagger2 {
@ bean
公共摘要createRestApi () {
返回新摘要(DocumentationType.SWAGGER_2)
.apiInfo (apiInfo ())
.select ()
.apis (RequestHandlerSelectors.basePackage (“com.zyank.web"))
.paths (PathSelectors.any ())
.build ();
}
私人ApiInfo ApiInfo () {
返回新ApiInfoBuilder ()
.title(“弹簧引导中试用Swagger2构建的RESTful APIs")
.description(“更多弹簧引导相关文章请关注:http://blog.didispace.com/")
.termsOfServiceUrl (“http://blog.didispace.com/")
.contact (“leo")
.version (“1.0”)
.build ();
}
} 控制器内使用
包com.zyank.web;
进口java.util.ArrayList;
进口java.util.Collections;
进口java.util.HashMap;
进口并不知道;
进口java.util.Map;
进口org.springframework.web.bind.annotation.PathVariable;
进口org.springframework.web.bind.annotation.RequestBody;
进口org.springframework.web.bind.annotation.RequestMapping;
进口org.springframework.web.bind.annotation.RequestMethod;
进口org.springframework.web.bind.annotation.RestController;
进口com.zyank.domain.User;
进口io.swagger.annotations.ApiImplicitParam;
进口io.swagger.annotations.ApiImplicitParams;
进口io.swagger.annotations.ApiOperation;
@RestController
@RequestMapping (value=https://www.yisu.com/zixun//用户)
公开课UserContrller {
静态地图=<长,用户>用户集合。synchronizedMap(新HashMap <长,用户> ());
@ApiOperation (value="获取用户列表”,指出=" ")
@RequestMapping(值={"},方法=RequestMethod.GET)
公共列表<用户> getUserList () {
<用户列表> r=新ArrayList <用户> (users.values ());
返回r;
}
@ApiOperation (value="创建用户”,指出=案萦没Ф韵蟠唇ㄓ没А?
@ApiImplicitParam (name="用户" value="用户详细实体用户”,要求=true,数据类型=坝没А?
@RequestMapping (value="、方法=RequestMethod.POST)
公共字符串postUser (@RequestBody用户用户){
users.put (user.getId()、用户);
返回“成功”;
}
@ApiOperation (value="获取用户详细信息”,指出=案輚rl的id来获取用户详细信息”)
@ApiImplicitParam (name=" id " value="用户id”,要求=true, paramType=奥肪丁?数据类型=俺ぁ?
@RequestMapping (value="/{id}”、方法=RequestMethod.GET)
公共用户getUser (@PathVariable长id) {
返回users.get (id);
}
@ApiOperation (value="更新用户详细信息”,指出=案輚rl的id来指定更新对象,并根据传过来的用户信息来更新用户详细信息”)
@ApiImplicitParams ({
@ApiImplicitParam (name=" id " value="用户id”,要求=true, paramType=奥肪丁?数据类型=俺ぁ?,
@ApiImplicitParam (name="用户" value="用户详细实体用户”,要求=true,数据类型=坝没А?
})
@RequestMapping (value="/{id}”、方法=RequestMethod.PUT)
公共字符串putUser (@PathVariable id, @RequestBody用户用户){
用户u=users.get (id);
u.setName (user.getName ());
u.setAge (user.getAge ());
用户。把(id, u);
返回“成功”;
}
@ApiOperation (value="删除用户”,指出=案輚rl的id来指定删除对象”)
@ApiImplicitParam (name=" id " value="用户id”,要求=true,数据类型=俺ぁ?
@RequestMapping (value="/{id}”、方法=RequestMethod.DELETE)
公共字符串deleteUser (@PathVariable长id) {
users.remove (id);
返回“成功”;
}
}在SpringBoot中结合Swagger2实现Restful的方法
