springboot整合swagger2详细步骤!
swagger是一个方便后端别嫌接口文档的开源项目,并且提供了界面话的测试
项目搭建
1.首先需要导入swagger2的2个依赖
pom.xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
2.Swagger2配置类,在项目创建成功之后,只需要开发者自己提供一个Docket的Bean即可
* 描述:springboot整合swagger文档接口 作用:前后端对接所要说明的情况
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.pathMapping("/")
.select()
.apis(RequestHandlerSelectors.basePackage("com.mrn.demo12.controller"))
.paths(PathSelectors.any())
.build().apiInfo(new ApiInfoBuilder()
.title("SpringBoot整合Swagger")
.description("SpringBoot整合Swagger,详细信息......")
.version("9.0")
.contact(new Contact("啊啊啊啊","blog.csdn.net","aaa@gmail.com"))
.license("The Apache License")
.licenseUrl("http://www.baidu.com")
.build());
}
}
如此,Swagger2就算配置成功了,非常方便。
此时启动项目,输入http://localhost:8080/swagger-ui.html,能够看到如下页面,说明已经配置成功了
接下来可以创建controller
*/
@RestController
@Api(tags = "static项目接口")
public class StaticController {
@PostMapping("/h1")
@ApiOperation("跳转页面")
public String statics(){
return "login.html";
}
@ApiOperation("登陆验证")
@GetMapping(value = "/login")
@ApiImplicitParams({
@ApiImplicitParam(name = "username",value = "用户名字",defaultValue = "黑鬼"),
@ApiImplicitParam(name = "password",value = "用户密码",defaultValue = "0.0123",required = true)
})
public String deng(@RequestParam(value = "username") String username,
@RequestParam(value = "password") String password,
Map<String,Object> map, HttpSession session){
// if (!StringUtils.isEmpty(username)&&"123456".equals(password)){
if ("123456".equals(username)&&"123456".equals(password)){
//放在session当中,用于判断是否登录
session.setAttribute("admin", username);
//登录成功,防止表单重复提交,进行重定向
return "index";
}else {
map.put("msg", "用户名或者密码错误");
return "login";
}
}
}
启动项目 访问 http://localhost:8080/swagger-ui.html
可以看到添加controller的效果图
展开内部细看
好啦,讲到这里。我们就要再见了 喜欢点个赞谢谢