| <div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/zh-CN/"><div class="navbar__logo"><img src="/zh-CN/img/logo.png" alt="Apache Linkis Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/zh-CN/img/logo.png" alt="Apache Linkis Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Apache Linkis</b></a><a class="navbar__item navbar__link" href="/zh-CN/download/main">下载</a><a class="navbar__item navbar__link" href="/zh-CN/community/how-to-subscribe">社区</a><a class="navbar__item navbar__link" href="/zh-CN/blog">博客</a><a class="navbar__item navbar__link" href="/zh-CN/team">团队</a><a class="navbar__item navbar__link" href="/zh-CN/user">用户</a><a href="https://docs.qq.com/doc/DUkdTTGhVSlZ0VXVt" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">FAQ</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Apache</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">基金会</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">证书</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">事件</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">安全</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">赞助</a></li><li><a href="https://privacy.apache.org/policies/privacy-policy-public.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">致谢</a></li></ul></div></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">文档</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/zh-CN/docs/latest/about/introduction">1.5.0</a></li><li><a class="dropdown__link" href="/zh-CN/docs/1.4.0/about/introduction">1.4.0</a></li><li><a class="dropdown__link" href="/zh-CN/docs/1.3.2/about/introduction">1.3.2</a></li><li><a class="dropdown__link" href="/zh-CN/docs/1.6.0/about/introduction">Next(1.6.0)</a></li><li><a class="dropdown__link" href="/zh-CN/versions">All Version</a></li></ul></div><a href="https://github.com/apache/linkis" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub"></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_nlXk"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>简体中文</a><ul class="dropdown__menu"><li><a href="/docs/latest/development/swwager" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="en">English</a></li><li><a href="/zh-CN/docs/latest/development/swwager" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="zh-CN">简体中文</a></li></ul></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="搜索"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">搜索</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="回到顶部" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebar_njMd"><nav class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh-CN/docs/latest/about/introduction">关于 Linkis</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh-CN/docs/latest/quick/live-demo">快速体验</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh-CN/docs/latest/deployment/deploy-quick">部署指南</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh-CN/docs/latest/user-guide/how-to-use">使用指南</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh-CN/docs/latest/engine-usage/overview">引擎使用</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh-CN/docs/latest/auth/ldap">安全认证</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh-CN/docs/latest/api/overview">API</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh-CN/docs/latest/architecture/overview">架构设计</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/zh-CN/docs/latest/development/directory-structure">开发指南</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/latest/development/directory-structure">目录结构</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/latest/development/build">后端编译</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/latest/development/build-console">管理台编译</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/latest/development/build-docker">Docker 编译</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/latest/development/debug">调试 Debug 指引</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/latest/development/debug-with-helm-charts">容器化开发调试</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/latest/development/new-engine-conn">如何实现新引擎</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/latest/development/new-microservice">如何实现新的微服务</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/zh-CN/docs/latest/development/swwager">Swagger 注解使用</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/zh-CN/docs/latest/development/config">配置参数介绍</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/zh-CN/docs/latest/development/development-specification/overview">开发规范</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/zh-CN/docs/latest/development/table/all">表结构</a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh-CN/docs/latest/tuning-and-troubleshooting/overview">调优排障</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh-CN/docs/latest/upgrade/upgrade-from-0.X-to-1.0-guide">升级指南</a></div></li></ul></nav></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="页面路径"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="主页面" class="breadcrumbs__link" href="/zh-CN/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_OVgt"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">开发指南</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Swagger 注解使用</span><meta itemprop="position" content="2"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">版本：1.5.0</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Swagger 注解使用</h1></header><h2 class="anchor anchorWithStickyNavbar_LWe7" id="1-swagger注解的作用域">1. Swagger注解的作用域<a class="hash-link" href="#1-swagger注解的作用域" title="Direct link to heading"></a></h2><table><thead><tr><th>API</th><th>作用范围</th><th>使用位置</th></tr></thead><tbody><tr><td>@Api</td><td>协议集描述</td><td>用于controller类上</td></tr><tr><td>@ApiOperation</td><td>协议描述</td><td>用在controller的方法上</td></tr><tr><td>@ApiImplicitParams</td><td>非对象参数集</td><td>用在controller的方法上</td></tr><tr><td>@ApiImplicitParam</td><td>非对象参数描述</td><td>用在@ApiImplicitParams的方法里边</td></tr><tr><td>@ApiResponses</td><td>Response集</td><td>用在controller的方法上</td></tr><tr><td>@ApiResponse</td><td>Response</td><td>用在 @ApiResponses里边</td></tr><tr><td>@ApiModel</td><td>描述返回对象的意义</td><td>用在返回对象类上</td></tr><tr><td>@ApiModelProperty</td><td>对象属性</td><td>用在出入参数对象的字段上</td></tr><tr><td>@ApiParam</td><td>协议描述</td><td>用在方法、参数、类的字段上</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="2-api">2. @Api<a class="hash-link" href="#2-api" title="Direct link to heading"></a></h2><p>使用位置即用在类上，对请求类进行描述。标识一个Controller类是Swagger文档类。</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="21-注解的属性">2.1 注解的属性<a class="hash-link" href="#21-注解的属性" title="Direct link to heading"></a></h3><table><thead><tr><th>属性名称</th><th>属性类型</th><th>属性默认值</th><th>属性描述</th></tr></thead><tbody><tr><td>value</td><td>String</td><td>""</td><td>描述，无实际意义。</td></tr><tr><td>tags</td><td>String[]</td><td>""</td><td>分组</td></tr><tr><td>basePath</td><td>String</td><td>""</td><td>基本路径</td></tr><tr><td>protocols</td><td>String</td><td>int</td><td>请求协议</td></tr><tr><td>authorizations</td><td>Authorization[]</td><td>@Authorization(value = "")</td><td>高级特性认证时的配置</td></tr><tr><td>hidden</td><td>boolean</td><td>false</td><td>是否隐藏（不显示,默认为false）</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="22-属性valuetags二者的区别">2.2 属性value、tags二者的区别<a class="hash-link" href="#22-属性valuetags二者的区别" title="Direct link to heading"></a></h3><p>value属性作用在类和作用在方法上都用于描述；</p><p>tags属性作用在类和作用在方法上都用于分组，但分组的效果区别很大：</p><p>tags作用在类上时，会对全局的方法分组，即根据tags属性值复制多份，此时方法上的tags值无效，方法上tags配或不配效果都一样。</p><p>tags作用在方法上时，会根据当前类的所有方法的tags值做分组，粒度更细。</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="23-使用方法">2.3 使用方法<a class="hash-link" href="#23-使用方法" title="Direct link to heading"></a></h3><font color="red">注意：java和scala在@Api注解上使用的区别 </font><div class="language-java codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-java codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">*java</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@Api(tags = "Swagger测试相关接口")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@RestController</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">*scala</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@Api(tags = Array("Swagger测试相关接口"))</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@RestController</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="3-apioperation">3. @ApiOperation<a class="hash-link" href="#3-apioperation" title="Direct link to heading"></a></h2><p>用在方法上，对请求方法进行描述。</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="31-注解的属性">3.1 注解的属性<a class="hash-link" href="#31-注解的属性" title="Direct link to heading"></a></h3><table><thead><tr><th>属性名称</th><th>属性类型</th><th>属性默认值</th><th>属性描述</th></tr></thead><tbody><tr><td>value</td><td>String</td><td>""</td><td>描述</td></tr><tr><td>notes</td><td>String</td><td>""</td><td>详细描述</td></tr><tr><td>tags</td><td>String[]</td><td>""</td><td>分组</td></tr><tr><td>response</td><td>Class<?></td><td>Void.class</td><td>响应参数类型</td></tr><tr><td>responseReference</td><td>String[]</td><td>""</td><td>指定对响应类型的引用，本地/远程引用，并将覆盖任何其它指定的response()类</td></tr><tr><td>httpMethod</td><td>String</td><td>""</td><td>http请求方式，如：GET、HEAD、POST、PUT、DELETE、OPTION、SPATCH</td></tr><tr><td>hidden</td><td>boolean</td><td>false</td><td>是否隐藏（不显示）默认为false</td></tr><tr><td>code</td><td>int</td><td>200</td><td>http的状态码</td></tr><tr><td>extensions</td><td>Extension[]</td><td>@Extension(properties = @ExtensionProperty(name = "", value = "")</td><td>扩展属性</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="32-使用方法">3.2 使用方法<a class="hash-link" href="#32-使用方法" title="Direct link to heading"></a></h3><div class="language-java codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-java codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">@GetMapping("test1")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@ApiOperation(value = "test1接口",notes = "test1接口详细描述")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">public ApiResult<String> test1(@RequestParam String aa, @RequestParam String bb, @RequestParam String cc) {</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> return ApiUtil.success("success");</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="4-apiimplicitparams">4. @ApiImplicitParams<a class="hash-link" href="#4-apiimplicitparams" title="Direct link to heading"></a></h2><p>常用在方法上，对请求参数列表进行描述。 |
| 其中的value属性可包含多个@ApiImplicitParam，对每个参加进行具体的描述。</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="41-注解的属性">4.1 注解的属性<a class="hash-link" href="#41-注解的属性" title="Direct link to heading"></a></h3><table><thead><tr><th>属性名称</th><th>属性类型</th><th>属性默认值</th><th>属性描述</th></tr></thead><tbody><tr><td>value</td><td>String</td><td>""</td><td>描述</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="5-apiimplicitparams">5. @ApiImplicitParams<a class="hash-link" href="#5-apiimplicitparams" title="Direct link to heading"></a></h2><p>用在方法上，对请求参数进行描述。当需要对多个参数进行描述时，作为@ApiImplicitParams的属性使用。</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="51-注解的属性">5.1 注解的属性<a class="hash-link" href="#51-注解的属性" title="Direct link to heading"></a></h3><table><thead><tr><th>属性名称</th><th>属性类型</th><th>属性默认值</th><th>属性描述</th></tr></thead><tbody><tr><td>value</td><td>String</td><td>""</td><td>描述</td></tr><tr><td>name</td><td>String</td><td>""</td><td>参数说明</td></tr><tr><td>defaultValue</td><td>String</td><td>""</td><td>默认值</td></tr><tr><td>allowableValues</td><td>String</td><td>""</td><td>参数允许值</td></tr><tr><td>required</td><td>boolean</td><td>false</td><td>是否必填,默认false</td></tr><tr><td>access</td><td>String</td><td>""</td><td>参数过滤</td></tr><tr><td>allowMultiple</td><td>boolean</td><td>false</td><td>参数是否可以通过多次出现来接受多个值，默认不允许</td></tr><tr><td>dataType</td><td>String</td><td>""</td><td>参数的数据类型，可以使类名或原始数据类型</td></tr><tr><td>dataTypeClass</td><td>Class<?></td><td>Void.class</td><td>参数的数据类型，如果提供则覆盖 dataType</td></tr><tr><td>paramType</td><td>String</td><td>""</td><td>参数类型，有效值为 path, query, body, header, form</td></tr><tr><td>example</td><td>String</td><td>""</td><td>非body类型的参数示例</td></tr><tr><td>examples</td><td>Example</td><td>@Example(value = @ExampleProperty(mediaType = “”, value = “”))</td><td>body类型的参数示例</td></tr><tr><td>type</td><td>String</td><td>""</td><td>添加覆盖检测到的类型的功能</td></tr><tr><td>format</td><td>String</td><td>""</td><td>添加提供自定义format格式的功能</td></tr><tr><td>readOnly</td><td>boolean</td><td>false</td><td>添加被指定为只读的功能</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="52-使用方法">5.2 使用方法<a class="hash-link" href="#52-使用方法" title="Direct link to heading"></a></h3><div class="language-java codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-java codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">@GetMapping("test1")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@ApiOperation(value = "test1接口",notes = "test1接口详细描述")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@ApiImplicitParams(value = {</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> @ApiImplicitParam(name = "aa",value = "aa的说明",defaultValue = "1",allowableValues = "1,2,3",required = true),</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> @ApiImplicitParam(name = "bb",value = "bb的说明",defaultValue = "1",allowableValues = "1,2,3",required = true),</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> @ApiImplicitParam(name = "cc",value = "cc的说明",defaultValue = "2",allowableValues = "1,2,3",required = true),</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">})</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="6-apiparam">6. @ApiParam<a class="hash-link" href="#6-apiparam" title="Direct link to heading"></a></h2><p>用在方法、参数、类的字段上，对请求参数进行描述。</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="61-注解的属性">6.1 注解的属性<a class="hash-link" href="#61-注解的属性" title="Direct link to heading"></a></h3><table><thead><tr><th>属性名称</th><th>属性类型</th><th>属性默认值</th><th>属性描述</th></tr></thead><tbody><tr><td>value</td><td>String</td><td>""</td><td>描述</td></tr><tr><td>name</td><td>String</td><td>""</td><td>参数说明</td></tr><tr><td>defaultValue</td><td>String</td><td>""</td><td>默认值</td></tr><tr><td>allowableValues</td><td>String</td><td>""</td><td>参数允许值</td></tr><tr><td>required</td><td>boolean</td><td>false</td><td>是否必填,默认false</td></tr><tr><td>access</td><td>String</td><td>""</td><td>参数过滤</td></tr><tr><td>allowMultiple</td><td>boolean</td><td>false</td><td>参数是否可以通过多次出现来接受多个值，默认不允许</td></tr><tr><td>dataType</td><td>String</td><td>""</td><td>参数的数据类型，可以使类名或原始数据类型</td></tr><tr><td>dataTypeClass</td><td>Class<?></td><td>Void.class</td><td>参数的数据类型，如果提供则覆盖 dataType</td></tr><tr><td>paramType</td><td>String</td><td>""</td><td>参数类型，有效值为 path, query, body, header, form</td></tr><tr><td>example</td><td>String</td><td>""</td><td>非body类型的参数示例</td></tr><tr><td>examples</td><td>Example</td><td>@Example(value = @ExampleProperty(mediaType = “”, value = “”))</td><td>body类型的参数示例</td></tr><tr><td>type</td><td>String</td><td>""</td><td>添加覆盖检测到的类型的功能</td></tr><tr><td>format</td><td>String</td><td>""</td><td>添加提供自定义format格式的功能</td></tr><tr><td>readOnly</td><td>boolean</td><td>false</td><td>添加被指定为只读的功能</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="62-使用方法">6.2 使用方法<a class="hash-link" href="#62-使用方法" title="Direct link to heading"></a></h3><div class="language-java codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-java codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">@GetMapping("test2")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@ApiOperation(value = "test2接口",notes = "test2接口详细描述")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">public ApiResult<TestRes> test2(@ApiParam(value = "aa的说明") @RequestParam String aa, @ApiParam(value = "bb的说明") @RequestParam String bb) {</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> return ApiUtil.success(new TestRes());</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="7-apimodel">7. @ApiModel<a class="hash-link" href="#7-apimodel" title="Direct link to heading"></a></h2><p>用在类上，对请求、响应类,实体类进行描述。</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="71-注解的属性">7.1 注解的属性<a class="hash-link" href="#71-注解的属性" title="Direct link to heading"></a></h3><table><thead><tr><th>属性名称</th><th>属性类型</th><th>属性默认值</th><th>属性描述</th></tr></thead><tbody><tr><td>value</td><td>String</td><td>""</td><td>为提供模型的替代名称，默认情况下，使用类名</td></tr><tr><td>description</td><td>String</td><td>""</td><td>类的描述</td></tr><tr><td>parent</td><td>Class<?> parent</td><td>Void.class</td><td>为模型提供父类以允许描述继承关系</td></tr><tr><td>discriminatory</td><td>String</td><td>""</td><td>支持模型继承和多态，使用鉴别器的字段的名称，可以断言需要使用哪个子类型</td></tr><tr><td>subTypes</td><td>boolean</td><td>false</td><td>是否必填,默认false</td></tr><tr><td>access</td><td>Class<?> parent</td><td>Void.class</td><td>从此模型继承的子类型数组</td></tr><tr><td>reference</td><td>boolean</td><td>false</td><td>指定对应类型定义的引用，覆盖指定的任何其他元数据</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="8-apimodelproperty">8 @ApiModelProperty<a class="hash-link" href="#8-apimodelproperty" title="Direct link to heading"></a></h2><p>用在类上，对请求、响应类,实体类进行描述。</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="81-注解的属性">8.1 注解的属性<a class="hash-link" href="#81-注解的属性" title="Direct link to heading"></a></h3><table><thead><tr><th>属性名称</th><th>属性类型</th><th>属性默认值</th><th>属性描述</th></tr></thead><tbody><tr><td>value</td><td>String</td><td>""</td><td>属性说明</td></tr><tr><td>name</td><td>String</td><td>""</td><td>覆盖属性的名称</td></tr><tr><td>allowableValues</td><td>String</td><td>""</td><td>参数允许值</td></tr><tr><td>access</td><td>String</td><td>""</td><td>过滤属性</td></tr><tr><td>required</td><td>boolean</td><td>false</td><td>是否必填,默认false</td></tr><tr><td>dataType</td><td>String</td><td>""</td><td>参数的数据类型，可以使类名或原始数据类型</td></tr><tr><td>hidden</td><td>boolean</td><td>false</td><td>是否隐藏</td></tr><tr><td>readOnly</td><td>String</td><td>""</td><td>添加被指定为只读的功能</td></tr><tr><td>reference</td><td>String</td><td>""</td><td>指定对应类型定义的引用，覆盖指定的任何其他元数据</td></tr><tr><td>allowEmptyValue</td><td>boolean</td><td>false</td><td>允许传空值</td></tr><tr><td>example</td><td>String</td><td>""</td><td>属性的示例值</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="82-使用方法">8.2 使用方法<a class="hash-link" href="#82-使用方法" title="Direct link to heading"></a></h3><font color="red">注意：java和scala在@ApiModelProperty注解上的使用的区别 </font><div class="language-java codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-java codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">*java实体类</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@Data</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@ApiModel(description = "测试请求类")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">public class TestReq {</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> @ApiModelProperty(value = "用户ID",required = true)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> private Long userId;</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> @ApiModelProperty(value = "用户名",example = "张三")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">}</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">*scala实体类</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@Data</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@ApiModel(description = "测试响应类")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">public class TestRes {</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> @(ApiModelProperty @field)("用户ID")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> private Long userId;</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> @(ApiModelProperty @field)("用户名")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="9-apiresponses">9. @ApiResponses<a class="hash-link" href="#9-apiresponses" title="Direct link to heading"></a></h2><p>用在方法、类上，对响应状态码列表进行描述。</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="91-注解的属性">9.1 注解的属性<a class="hash-link" href="#91-注解的属性" title="Direct link to heading"></a></h3><table><thead><tr><th>属性名称</th><th>属性类型</th><th>属性默认值</th><th>属性描述</th></tr></thead><tbody><tr><td>value</td><td>ApiResponse[]</td><td>""</td><td>响应状态码列表的描述</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="10-apiresponse">10. @ApiResponse<a class="hash-link" href="#10-apiresponse" title="Direct link to heading"></a></h2><p>用在方法上，对响应状态码进行描述。一般作为@ApiResponses的属性使用。</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="101-注解的属性">10.1 注解的属性<a class="hash-link" href="#101-注解的属性" title="Direct link to heading"></a></h3><table><thead><tr><th>属性名称</th><th>属性类型</th><th>属性默认值</th><th>属性描述</th></tr></thead><tbody><tr><td>code</td><td>int</td><td>""</td><td>响应的HTTP状态码</td></tr><tr><td>message</td><td>String</td><td>""</td><td>响应的描述</td></tr><tr><td>response</td><td>Class<?></td><td>Void.class</td><td>用于描述消息有效负载的可选响应类，对应于响应消息对象的 schema 字段</td></tr><tr><td>reference</td><td>String</td><td>""</td><td>指定对响应类型的引用，指定的应用可以使本地引用，也可以是远程引用，将按原样使用，并将覆盖任何指定的response()类</td></tr><tr><td>responseHeaders</td><td>ResponseHeader[]</td><td>@ResponseHeader(name = "", response = Void.class)</td><td>可能响应的header列表</td></tr><tr><td>responseContainer</td><td>String</td><td>""</td><td>声明响应的容器，有效值为List,Set,Map，任何其他值都将被忽略</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="102-使用方法">10.2 使用方法<a class="hash-link" href="#102-使用方法" title="Direct link to heading"></a></h3><div class="language-java codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-java codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">@GetMapping("test2")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@ApiOperation(value = "test2接口",notes = "test2接口详细描述")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">@ApiResponses(value = {</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> @ApiResponse(code = 200, message = "请求成功", responseHeaders = {@ResponseHeader(name = "header1", description = "header1的描述",response = String.class)}),</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> @ApiResponse(code = 401, message = "没有权限"),</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> @ApiResponse(code = 403, message = "禁止访问")</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">})</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">public ApiResult<TestRes> test2(@ApiParam(value = "aa的说明") @RequestParam String aa, @ApiParam(value = "bb的说明") @RequestParam String bb) {</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> return ApiUtil.success(new TestRes());</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">}</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/linkis-website/edit/dev/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.5.0/development/swwager.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>编辑</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/zh-CN/docs/latest/development/new-microservice"><div class="pagination-nav__sublabel">上一篇</div><div class="pagination-nav__label">如何实现新的微服务</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/zh-CN/docs/latest/development/config"><div class="pagination-nav__sublabel">下一篇</div><div class="pagination-nav__label">配置参数介绍</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#1-swagger注解的作用域" class="table-of-contents__link toc-highlight">1. Swagger注解的作用域</a></li><li><a href="#2-api" class="table-of-contents__link toc-highlight">2. @Api</a><ul><li><a href="#21-注解的属性" class="table-of-contents__link toc-highlight">2.1 注解的属性</a></li><li><a href="#22-属性valuetags二者的区别" class="table-of-contents__link toc-highlight">2.2 属性value、tags二者的区别</a></li><li><a href="#23-使用方法" class="table-of-contents__link toc-highlight">2.3 使用方法</a></li></ul></li><li><a href="#3-apioperation" class="table-of-contents__link toc-highlight">3. @ApiOperation</a><ul><li><a href="#31-注解的属性" class="table-of-contents__link toc-highlight">3.1 注解的属性</a></li><li><a href="#32-使用方法" class="table-of-contents__link toc-highlight">3.2 使用方法</a></li></ul></li><li><a href="#4-apiimplicitparams" class="table-of-contents__link toc-highlight">4. @ApiImplicitParams</a><ul><li><a href="#41-注解的属性" class="table-of-contents__link toc-highlight">4.1 注解的属性</a></li></ul></li><li><a href="#5-apiimplicitparams" class="table-of-contents__link toc-highlight">5. @ApiImplicitParams</a><ul><li><a href="#51-注解的属性" class="table-of-contents__link toc-highlight">5.1 注解的属性</a></li><li><a href="#52-使用方法" class="table-of-contents__link toc-highlight">5.2 使用方法</a></li></ul></li><li><a href="#6-apiparam" class="table-of-contents__link toc-highlight">6. @ApiParam</a><ul><li><a href="#61-注解的属性" class="table-of-contents__link toc-highlight">6.1 注解的属性</a></li><li><a href="#62-使用方法" class="table-of-contents__link toc-highlight">6.2 使用方法</a></li></ul></li><li><a href="#7-apimodel" class="table-of-contents__link toc-highlight">7. @ApiModel</a><ul><li><a href="#71-注解的属性" class="table-of-contents__link toc-highlight">7.1 注解的属性</a></li></ul></li><li><a href="#8-apimodelproperty" class="table-of-contents__link toc-highlight">8 @ApiModelProperty</a><ul><li><a href="#81-注解的属性" class="table-of-contents__link toc-highlight">8.1 注解的属性</a></li><li><a href="#82-使用方法" class="table-of-contents__link toc-highlight">8.2 使用方法</a></li></ul></li><li><a href="#9-apiresponses" class="table-of-contents__link toc-highlight">9. @ApiResponses</a><ul><li><a href="#91-注解的属性" class="table-of-contents__link toc-highlight">9.1 注解的属性</a></li></ul></li><li><a href="#10-apiresponse" class="table-of-contents__link toc-highlight">10. @ApiResponse</a><ul><li><a href="#101-注解的属性" class="table-of-contents__link toc-highlight">10.1 注解的属性</a></li><li><a href="#102-使用方法" class="table-of-contents__link toc-highlight">10.2 使用方法</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Linkis</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/zh-CN/docs/latest/about/introduction">文档</a></li><li class="footer__item"><a class="footer__link-item" href="/zh-CN/faq/main">FAQ</a></li><li class="footer__item"><a href="https://github.com/apache/linkis/releases" target="_blank" rel="noopener noreferrer" class="footer__link-item">版本</a></li></ul></div><div class="col footer__col"><div class="footer__title">社区</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/apache/linkis" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li><li class="footer__item"><a href="https://github.com/apache/linkis/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item">Issue Tracker</a></li><li class="footer__item"><a href="https://github.com/apache/linkis/pulls" target="_blank" rel="noopener noreferrer" class="footer__link-item">Pull Requests</a></li></ul></div><div class="col footer__col"><div class="footer__title">订阅邮件组</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/zh-CN/community/how-to-subscribe">如何订阅</a></li><li class="footer__item"><a href="mailto:dev-subscribe@linkis.apache.org" target="_blank" rel="noopener noreferrer" class="footer__link-item">订阅邮件</a></li><li class="footer__item"><a href="https://lists.apache.org/list.html?dev@linkis.apache.org" target="_blank" rel="noopener noreferrer" class="footer__link-item">邮件归档</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright"><div style="text-align: left;"> |
