当前位置:网站首页 > 技术博客 > 正文

swagger2的使用



编写和维护接口文档是每个程序员的职责,根据Swagger2可以快速帮助我们编写最新的API接口文档,再也不用担心开会前仍忙于整理各种资料了,间接提升了团队开发的沟通效率。

swagger通过注解表明该接口会生成文档,包括接口名、请求方法、参数、返回信息的等等。

  • @Api:修饰整个类,描述Controller的作用
  • @ApiOperation:描述一个类的一个方法,或者说一个接口
  • @ApiParam:单个参数描述
  • @ApiModel:用对象来接收参数
  • @ApiModelProperty:用对象接收参数时,描述对象的一个字段
  • @ApiImplicitParam:一个请求参数
  • @ApiImplicitParams:多个请求参数

在这里插入图片描述

 
  

在这里插入图片描述

 
  

如下图所示,因为service文件下的子模块中要编写业务代码。进行业务测试。所以在service的pom.xml文件中引入有swagger模块的坐标。
service文件下的子模块都可以使用该功能。
在这里插入图片描述

启动service_hosp主程序:
在这里插入图片描述
输入网址:http://localhost:8201/swagger-ui.html
在这里插入图片描述


版权声明


相关文章:

  • 小程序码在哪找2025-10-10 19:01:00
  • 在线代码查看器2025-10-10 19:01:00
  • 单臂路由的作用是什么?2025-10-10 19:01:00
  • mininet安装2025-10-10 19:01:00
  • c语言中malloc函数的用法2025-10-10 19:01:00
  • java的console怎么调出来2025-10-10 19:01:00
  • knn算法和kmeans算法区别2025-10-10 19:01:00
  • 什么叫线程安全2025-10-10 19:01:00
  • c语言指针数组和数组指针怎么用2025-10-10 19:01:00
  • libxml2.so.2在那里放着2025-10-10 19:01:00