栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Swagger

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Swagger

 前后端分离:VUE+springboot

1.职责

1)后端:后端控制层,服务层,数据访问 即controller,service,mapper

2)前端:前端控制层,视图层

      前端通过数据伪造,依然正常执行项目

2.交互方式

通过API(应用程序接口)交互,松耦合

这样做产生一个问题:前后端集成联调,无法做到有问题及时解决

3.简介

1)Swagger:世界上最流行的api框架

2)在线运行

3)Restful  在线文档自动生成   api文档和api接口同步更新

swagger官网:API Documentation & Design Tools for Teams | Swagger

二.springboot项目集成swagger

1.创建springboot项目

2.导入swagger坐标依赖

3.创建applicaiotn.yml和controller文件

4.配置swagger-config

创建一个配置类,加上两个@Configuration,@EnableSwagger2 的注释即可

 5.访问swagger即可,地址:localhost:8080/swagger-ui.html

Swagger UI

三. 配置Swagger,

1).设置展示页面信息

 2)配置swagger的扫描,主要是指定扫描的包       docket(摘要)

这里是加上了多环境扫描,用profiles类调用of方法,将"dev,test放进去

3)swagger协同开发:创建多个Docket,那么在swagger界面就能展示多个成员的接口

 

4)实体类配置: 即页面上的model and view

@Api注解汇总

    1.@ApiModel:注解实体类

     2.@ApiModelProperty 注解实体类的属性

     3.@ApiOperation 加在接口的方法上,即Controller接口

    4.@ApiParam  放在接口方法的形参上,用于注释形参

 

 

 

四:应用,进入swagger页面后,打开对应的controller,输入参数点击execute执行,之后可以在下方界面得到返回值

文章写的不够详细,了解也不够深入,后续会继续改正!

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/1010614.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号