了解前后端分离 ，学习Swagger的使用， 在SpringBoot中集成Swagger
啦啦啦~接下来的期间就更新实训的一些学习叭~
最近来到一家公司实训，第一天公司的一个哥教我们使用Swagger，之前没有接触过，晚上找了视频简单学习了一下
前言 前后端分离： （通过API交互，相对独立，松耦合，甚至可以部署在不同的服务器上）SpringBoot+Vue是当前最主流的前后端分离的基础栈
（vue 有双向控制这样一个功能 前端视图都是由它下边的js渲染的 后端把数据传给它）
后端 ： 后端控制层，服务层，数据访问层 前端： 前端控制层，视图层前端伪造后端数据,已经存在的死数据，不需要后端前端工程照样能跑起来，请求的是本地的js里的json数据，项目真实上线以后请求的是后端写的接口，返回的json(一堆真实的，从数据库里拿的数据)
产生的问题： 前后端集成联动，前端开发与后端开发无法做到 及时协商，尽早解决 从而导致问题爆发 解决： 制定schema(计划的提纲)，实时更新最新的API，降低集成风险 Swagger简介 世界上最流行的APi框架 RestFul Api 文档在线自动生成工具 （API与API文档同步更新） 在线测试官网：https://swagger.io/
Swagger使用（SpringBoot集成swagger） 新建一个SpringBoot项目create new project->(左侧)Spring Initializr，SDK选用1.8(1.7不行)->next->填写项目名啥的->next->(左侧)web，选中Spring Web Starter->next->最后finsh
在pom里 添加jar包依赖
io.springfox
springfox-swagger2
2.9.2
io.springfox
springfox-swagger-ui
2.9.2
在controller里编写一个基本的接口
package com.rongsoft.personblog.backController;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
//如果要求方法返回的是json格式数据，而不是跳转页面，可以直接在类上标注@RestController，而不用在每个方法中标注@ResponseBody，简化了开发过程。
@RestController //相当于@Controller+@ResponseBody两个注解的结合，不能返回jsp,html页面
public class UserController {
@RequestMapping(value = "/hello")
public String hello(){
return "hello";
}
}
把swaggerconfig配置到sprignboot里
package com.rongsoft.personblog.config;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration //把swaggerConfig配置到SpringBoot里
@EnableSwagger2 //开启swagger2
public class SwaggerConfig {
}
测试运行：启动起来以后——>访问：http://localhost:8080/swagger-ui.html
让swagger只在生产环境中使用，发布的时候不使用
1.判断是否为生产环境 按照这样配置 则能打开，如果spring.profiles.active=pro的话就不能打开了
2.注入enable
配置多个分组 多个Docket实例即可
@Bean
public Docket docket1(){
return new Docket(DocumentationType.SWAGGER_2).groupName("A组");
}
注解
1.@ApiModel("给类加文档注释")
2.@ApiModelProperty("给字段加注释")
3.@ApiOperation("给接口方法加注释")
4.@ApiParam("给参数加注释")
测试
总的来说swagger 还是一个挺高效的 “工具” 吧
over~
我一定会解决的
原创文章 13获赞 28访问量 1807
关注
私信
展开阅读全文
作者：我一定会解决的
