2025年swagger2作用(swagger2使用教程)

swagger2作用(swagger2使用教程)Swagger 是为了解决企业中接口 api 中定义统一标准规范的文档生成工具 很多采用前后端分离的模式 前端只负责调用接口 进行渲染 前端和后端的唯一联系 变成了 API 接口 因此 API 文档变得越来越重要 swagger 是一个方便我们更好的编写 API 文档的框架 而且 swagger 可以模拟 http 请求调用 Api 用于类 表示标识这个类是 swagger 的资源

大家好,我是讯享网,很高兴认识大家。



​ Swagger是为了解决企业中接口(api)中定义统一标准规范的文档生成工具。很多采用前后端分离的模式,前端只负责调用接口,进行渲染,前端和后端的唯一联系,变成了API接口。因此,API文档变得越来越重要。swagger是一个方便我们更好的编写API文档的框架,而且swagger可以模拟http请求调用。

  • @Api()用于类:表示标识这个类是swagger的资源

  • 讯享网
  • @ApiOperation()用于方法:表示一个http请求的操作
  • 讯享网
  • @ApiParam():用于方法,参数,字段说明:表示对参数的添加元数据(说明或是否必填等)
  •  
  • @ApiModel()用于类:表示对类进行说明,用于参数用实体类接收


    讯享网

  • 讯享网
  • @ApiModelProperty()用于方法,字段:表示对model属性的说明或者是数据操作更改
  •  
  • @ApiIgnore()用于类,方法,方法参数:表示这个方法或者类被忽略
  • 讯享网
  • @ApiImplicitParam()用于方法:表示单独的请求参数

    @ApiImplicitParams()用于方法,包含多个@ApiImplicitParam

  •  
讯享网

给出一些基础配置

 
  

SpringBoot 配置文件 开启swagger

  • application-dev.yml文件
讯享网

注意导包不要导错

 
  
讯享网

代码中的@Getter@Setter 注解是使用 lombok代替get与set方法,使用方法参考另一篇

 
  

  • 界面
  • 可以看到刚才我们写的两个方法
  • 在这里插入图片描述
  • 在这里插入图片描述
  • 在这里插入图片描述
  • 小讯
    上一篇 2025-05-02 10:18
    下一篇 2025-06-12 10:59

    相关推荐

    版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请联系我们,一经查实,本站将立刻删除。
    如需转载请保留出处:https://51itzy.com/kjqy/170400.html