- 综合排序
- 最热优先
- 最新优先
- 来自专栏AI人工智能
AI 辅助文档生成：从接口注释到自动化 API 文档上线
经过大量的实践和调研，我发现AI辅助文档生成不仅能够大幅提升开发效率，还能保证文档的准确性和一致性。从最初的接口注释自动生成，到完整的API文档自动化上线，整个流程的智能化程度让我惊叹不已。 通过AI技术的加持，我们不仅能够实现文档的自动化生成，还能确保文档质量的持续提升。智能化的内容优化、多语言支持、交互式文档生成等高级特性，让文档不再是开发过程中的负担，而是成为提升团队协作效率的利器。 从最初的简单代码注释提取，到现在的智能化、自动化文档生成系统，这个技术领域正在经历着快速的发展和变革。在实际项目中，我见证了AI技术如何将原本繁琐的文档编写工作转变为高效、准确的自动化流程。 特别值得一提的是，AI技术的引入不仅仅是简单的自动化，更是对文档生成流程的智能化改造。通过机器学习和自然语言处理技术，系统能够理解代码的语义，生成高质量的文档内容，甚至能够预测和推荐文档改进建议。 - Python AST模块官方文档关键词标签AI文档生成 API文档自动化 代码注释解析 OpenAPI规范 CI/CD集成
1.2K10编辑于 2025-09-09 - 来自专栏国产
Swagger 自动化生成 Api 文档：优化管理与维护
为了降低手动编写文档带来的错误，很多 API 开发者会偏向于寻找一些好的方法来自动生成 API 文档。本文将会介绍一些常用的文档生成工具：开源工具 Tapir，商业化产品 Apifox。 Tapir 以可视化的方式显示 API 的不同端点和参数，并提供了丰富的编辑功能和自动化的 API 文档生成工具，可以生成易于阅读和理解的文档，同时也提供了多种导出格式（如 OpenAPI 规范、Markdown 5、自动生成 API 文档：Tapir 提供了一种自动生成 API 文档的方法，这使得 API 文档的创建变得简单且容易维护。 你可以选择在运行时从 API 定义生成文档，或者在构建时将 API 定义与文档绑定在一起。 虽然 Tapir 是一个非常有用的 API 设计和文档工具，但它也存在一些缺点： 学习成本较高：尽管 Tapir 提供了丰富的功能和自动化工具，但其高级抽象和复杂的用户界面可能会使初学者感到困惑。
1.2K20编辑于 2023-07-26 - 来自专栏前端lucio
VueJS文档生成
JSDoc语法 文档 jsdoc-vuejs插件新增了以下几个块标签 @vue-prop @vue-data @vue-computed 用法和@param一样。 6. 生成文档 在需要文档的地方，用块标签注释。
2.4K20编辑于 2023-04-22 - 来自专栏全栈程序员必看
POSTMAN自动生成接口文档_swagger自动生成接口文档
介绍 drf-spectacular是为Django REST Framework生成合理灵活的OpenAPI 3.0模式。 它可以自动帮我们提取接口中的信息，从而形成接口文档，而且内容十分详细，再也不用为写接口文档而心烦了 这个库主要实现了3个目标 从DRF中提取更多的schema信息 提供灵活性，使schema在现实世界中可用 (不仅仅是示例) 生成一个与最流行的客户端生成器配合良好的schema 环境准备 Python >= 3.6 Django (2.2, 3.1, 3.2) Django REST Framework TITLE和DESCRIPTION和VERSION，如果想自定义更多的设置，请看文档 自定义接口内容信息 上面我们可以访问swagger接口文档，但是我们点开接口会发现没有任何内容信息 所以我们还需要在 summary：一个可选的短的总结描述 deprecated：将操作标记为已弃用 tags：覆盖默认标记列表 exclude：设置为True以从schema中排除操作 operation：手动覆盖自动发现将生成的内容
3.1K20编辑于 2022-09-19 - 来自专栏vivo互联网技术
解放生产力，自动化生成vue组件文档
比如下面的例子，value属性与input事件可以合起来构成一个v-model属性，但是这个信息在生成的文档中没有体现出来，要文档读者自行理解判断。而且生成的文档中没有展示是否支持sync。 三、技术方案 针对以上文中提到的问题以及社区方案的不足，我们团队内沉淀出了一个小工具专门用于Vue组件信息获取并输出组件文档，大致效果如下： 上图中左边是一个常见的Vue单文件组件，右边是生成的文档。 而如果能进一步的使用工具把维护文档的过程自动化的话，那开发的幸福感还能得到再次提升。 经过一系列的摸索和尝试，我们成功的找到了 自动化提取Vue组件信息的方案，大大减轻了维护Vue组件文档的工作量，提升了文档信息的准确度。 具体实现上，先用vue-template-compiler对Vue文件进行处理，获得template的AST和js的AST，有了这两个AST后就可以去获取更加详细的信息了， 梳理一下到目前为止我们生成的文档里可以获取到的内容及获取方式
1.7K11发布于 2021-06-29 - 来自专栏后端1
接口文档生成工具 一键生成文档 ApiPost
一键生成文档 我们在“2分钟玩转APIPOST”一讲中，简单介绍了如何生成并分享接口文档： 点击分享文档 复制并打开文档地址就可以看到了完整的接口文档。 本节课主要是讲解一些需要注意的事项。 响应参数的描述填写 很多新手困惑为什么APIPOST分享的文档没有成功响应示例和错误响应示例，那是因为APIPOST不会把发送后的实时响应的数据作为响应示例。 Apipost官方链接： Apipost-基于协作，不止于API文档、调试、Mockconsole.apipost.cn/register?
1K30编辑于 2022-05-10 - 来自专栏复盘总结文章集合
MyEclipse生成javadoc文档
protected 前边带protected和public的都生成。 public 前边public的生成。（默认） ? 四。选好路径 ? 五。选择引用文件和项目以生成链接。 排除具有给定名称的所有文档文件子目录。 -group <name> <p1>:<p2>.. 不生成帮助链接 -nonavbar 不生成导航栏 -serialwarn 生成有关 @serial 标记的警告 的 @docRoot 替换为 <url> -charset <charset> 用于跨平台查看生成的文档的字符集。 指定源中每个制表符占据的空格数 -keywords 使程序包, 类和成员信息附带 HTML 元标记 -stylesheetfile <path> 用于更改生成文档的样式的文件
1.2K20发布于 2019-07-15 - 来自专栏HaC的技术专栏
MySQL生成word文档
把MySQL的表结构生成word文档说明的时候，可以借助以下方法： 下载驱动包 链接：https://pan.baidu.com/s/16tkYaO7l42XNxUPmQi5deQ 提取码：i6mq
5K10发布于 2020-12-30 - 来自专栏sofu456
doxygen文档生成工具
http://doxygen.nl/files/doxygen-1.8.17-setup.exe
1.7K10发布于 2020-04-08 - 来自专栏一朵灼灼华的博客
生成flask接口文档
背景 接触过几个针对flask自动生成接口文档的，但是感觉不太好用，然后发现了flask-docs，地址：https://github.com/kwkwc/flask-docs 但是感觉还是不太好用， 就进行了魔改 地址 https://gitee.com/heanny/flask-docs 添加的功能 可修改接口文档分类为中文 接口文档页面布局进行了优化美观 生成接口文档的方法进行了重构，并添加了部分兼容逻辑 添加了二级分类树 添加了html网页类型展示 修复部分问题 文档接口搜索已修复 测试页面接口及搜索已修复 form data可以使用，需要设置headers TODO 美化界面 增加的功能使用说明 中文类别 title="Sample App", version="1.0.0", description="A simple app API", ) doc.init_app(app) doc文档标题必须是第一行
2.7K10编辑于 2022-08-05 - 来自专栏《活动征集》
自动化API文档生成与Swagger UI集成：API文档，如何从枯燥变得生动有趣？
但，如果我告诉你有一种方法，能够自动化生成这些文档，且不需要担心和代码同步的问题，你是不是会觉得有点儿小兴奋？ 自动化生成文档：通过注释代码 5. Swagger UI：让文档“活”起来 6. 从零开始：一个简单的API文档示例 7. 自定义Swagger UI：加入你的个性 8. 接下来，你只需要通过注释代码来生成文档，Swagger会自动解析这些注释，展示给你。4. 自动化生成文档：通过注释代码 接下来的操作可有趣了！ 你只需要在代码中加上特定格式的注释，Swagger就会根据这些注释自动生成文档。 Swagger会根据这些注释自动生成接口文档，简直是懒人必备的神器！5. Swagger UI：让文档“活”起来 Swagger UI不仅能生成静态文档，更能提供交互式调试功能！
92710编辑于 2025-05-15 - 来自专栏FHADMIN
java生成word文档
} } } } } Map<String, Object> map=new HashMap<String, Object>(); //文档里面的列名为 ; 最后会有一个奇怪的bug，word文档里的${name}如果是手打上去就可以用，如果是复制上去就会被识别为三个字符串，也就是不能替换，当然也有解决方法，可以把全文复制到win自带的写字板（不需要调任何格式
2.4K20编辑于 2022-01-04 - 来自专栏同步文章
swagger生成接口文档
(https://swagger.io/) Spring Boot 可以集成Swagger，生成Swagger接口，Spring Boot是Java领域的神器，它是Spring项目下快速构建项目的框架。 2.Swagger常用注解 在Java类中添加Swagger的注解即可生成Swagger接口，常用Swagger注解如下： @Api：修饰整个类，描述Controller的作用 @ApiOperation pageAliase; //模版id @ApiModelProperty("模版id") private String templateId; } Swagger接口测试 Swagger接口生成工作原理 Swagger2Configuration类 2、在此类中指定了包路径com.xuecheng，找到在此包下及子包下标记有@RestController注解的controller类 3、根据controller类中的Swagger注解生成接口文档 启动项目，查看接口文档，请求：http://localhost:31001/swagger-ui.html 使用Swagger工具测试服务接口： 1）在cms服务接口中打断点 2）打开接口文档页面，输入请求参数
1.8K30编辑于 2022-10-25 - 来自专栏大话swift
自动生成API文档
帮助文档查看 swagger
2.2K20发布于 2019-07-03 - 来自专栏Hugo博客
APIDoc自动生成接口文档
对于项目开发常见的前后端分离模式来说，中间在后端完成接口开发交付对接时，前端人员往往苦于没有接口文档会经常"跑去"骚扰后端人员，真是苦不堪言哪。 要是此时有个文档化的说明那就轻松多啦，现在后端流行的文档生成利器有Swagger，它虽然方便，但是也有弊端得写在的后台的代码中，而且启动整个后台项目才能访问。 所有相关的准备工作完成后，那么此时我们就需要来写关于接口描述的文档，这个具体要看你今后实际项目的开发语言，建议尽量选择相同的，在此我就以Java为示例，不需要具体的代码，只需填充代码注释部分的内容， * ] * } * * @apiUse Suc200 * * @apiUse Err400 * */ 生成接口文档 最后我们生成接口文档只需要一句简单的命令即可 ，如下： 1 apidoc -i apidoc/ -o apidoc/ i 工程所在的文件夹 o 接口文档输出文件夹 文档效果如下图所示： 常见问题 提示 error: Can not read:
53510编辑于 2024-11-20 OpenAPI 文档代码生成工具
前言 OpenAPI 文档是基于 OpenAPI 规范（OpenAPI Specification, OAS）撰写的，主要用于描述 RESTful API 的一种标准化方式。 它是 API 文档的格式化规范，帮助开发者清晰地定义和理解 API 的结构和行为。 而 OpenAPI 代码生成工具是一类基于 OpenAPI 规范自动生成代码的工具。 通过这些工具，开发者可以快速生成符合规范的客户端 SDK、服务器端代码或文档，而无需手动编写固定格式的代码。通过这些工具加可以重复代码的编写，让开发者更专注于业务逻辑的实现。 和 3.0）的情况下自动生成 API 客户端库（SDK 生成）、服务器存根、文档和配置。 小结 OpenAPI 代码生成工具是现代 API 开发不可或缺的加速器。它们通过自动化生成代码、文档以及样板，让开发者专注于业务逻辑的创新。
1.6K107编辑于 2025-01-04- 来自专栏iOSDevLog
Xcode 自动生成文档
jazzy.png Xcode 文档注释快捷键： ⌥ + ⌘ + swift-documentation: https://nshipster.com/swift-documentation/ jazzy : Swift 和 Objective-C 的灵活文档 ---- https://github.com/realm/jazzy 安装 $ [sudo] gem install jazzy Command Line Tools $ xcode-select --install 确保选择正确的 Command Line Tools Command Line Tools.png 使用 $ jazzy 生成
1.5K20发布于 2019-04-17 - 来自专栏逸鹏说道
【开源】文档生成工具 DocFX
OpenLiveWriter/issues/203 详细：http://dotnet.github.io/docfx/tutorial/docfx_getting_started.html 微软最近开源了全新的文档生成工具 DocFX，目前支持C＃和VB，类似JSDoc或Sphinx，可以从源代码中提取注释生成文档之外，而且还有语法支 持你加入其他的文件链接到API添加额外的说明，DocFX会扫描你的源代码和附加的文件为你生成一个完整的
1.4K40发布于 2018-04-11 - 来自专栏国产
YApi自动生成接口文档
的官网下载，安装的话一直下一步下一步就行了npm 安装 YApi在终端里运行安装后会启动 yarpi server ，端口号是 9090部署 Yapi然后需要部署一下，这样才能在本地访问 Yapi 文档点击 可以记起来本地运行 YApi进到 Yapi-cli目录，运行这个时候浏览器的 3000 端口会运行 YApi 文档跨域插件如果想要在浏览器 YApi 访问到本地接口，需要安装 Yapi 提供的谷歌插件~ YApi Mock服务的使用教程 使用YApi实现接口自动化测试的技巧与方法
1K20编辑于 2023-05-06 - 来自专栏C/C++基础
Gin 生成 Swagger 接口文档
生成的 docs 包 注册 Gin router 5.FAQ 参考文献 1.背景 后台服务通过接口（如 RESTful API）对外提供服务时，需要有明确的接口文档。 书写接口文档，我们可以手动书写，也可以采用工具自动生成。手动书写的问题在于接口协议变更后需要维护接口文档，效率低下。采用工具生成，不同的工具生成的接口文档风格不一，增加阅读者的理解成本。 因此，我们可以采用业界常用的 Swagger 为 RESTful API 生成可交互的接口文档。 本文以 Gin 框架为例，描述 Gin 中如何为接口生成 Swagger 文档。 可通过编写 yaml 和 json 来实现接口的文档化，并且可以进行测试等工作。 通过 Swagger 可以方便地生成接口文档，方便前端进行查看和测试。 使用 Swagger 就是把接口相关信息存储在它定义的描述文件里面（yaml 或 json 格式），再通过维护这个描述文件可以去更新接口文档，以及生成各端代码。
2.9K30编辑于 2023-02-23
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号