- 综合排序
- 最热优先
- 最新优先
- 来自专栏前端lucio
VueJS文档生成
安装模板文件 minami npm install --save-dev minami 5. 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 - 来自专栏后端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 - 来自专栏前端技术江湖
H5基于Canvas实现电子签名并生成PDF文档
实现思路 使用canvas来实现手写签名的功能，然后将canvas转化为图片，贴在签名的位置； 将整个需要生成文档的dom区域使用html2canvas插件转成一张大图； 使用JsPDF插件将上述图片生成 PDF文档； 对于文件内容较多的情况，需要合理选择分页位置； 生成签名 1. 最后生成签名如下： ? 生成PDF文档 html2canvas是一款将HTML代码转换成Canvas的插件，因此需要用一个div包裹住需要打印的内容区域，获得这个dom节点。 PDF文档，但是当PDF页数有很多的时候，会有这样的问题⏬ ? PDF文档页数较少的情况 可以在开发测试的时候预先在将要分页的地方插入一个padding，就是提前预留分页位置 PDF文档页数较多 对于这种情况，笔者尝试遍历要打印的dom节点的子节点，将每一页所能打印的
4.5K10发布于 2021-01-06 - 来自专栏一朵灼灼华的博客
生成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 - 来自专栏FHADMIN
java生成word文档
} } } } } Map<String, Object> map=new HashMap<String, Object>(); //文档里面的列名为 ; 最后会有一个奇怪的bug，word文档里的${name}如果是手打上去就可以用，如果是复制上去就会被识别为三个字符串，也就是不能替换，当然也有解决方法，可以把全文复制到win自带的写字板（不需要调任何格式
2.4K20编辑于 2022-01-04 - 来自专栏大话swift
自动生成API文档
帮助文档查看 swagger
2.2K20发布于 2019-07-03 - 来自专栏同步文章
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 - 来自专栏用户9257747的专栏
5分钟集成实现SpringBoot自动生成API接口文档（上篇）
当你问10个开发人员想不想写开发文档，可能有11个人会告诉你，不想写；但是每个开发人员又希望别人能把文档写好，写清晰；那有没有方式可以不手写接口文档，能自动生成呢？ 5分钟，因为真的简单。 实战用法 效果展示 如上图所示测试项目；分了好多个模块；订单、商品、用户或者更多；如果生成文档呢？ 难道每一个模块生成一个？然后放到nginx里面，一个个的访问？ 获取主页页面 这部分内容比较多，就不占篇幅贴出来了 文件所在地址：https://gitee.com/pengfeilu/apigcc-demo/tree/master/api-doc-docker 每个模块生成文档 ，所以另外起了一个新的博客来介绍；《5分钟集成实现SpringBoot自动生成API接口文档（下篇）》 : https://lupf.cn/articles/2020/11/15/1605454832274
3.7K20编辑于 2022-04-06 OpenAPI 文档代码生成工具
前言 OpenAPI 文档是基于 OpenAPI 规范（OpenAPI Specification, OAS）撰写的，主要用于描述 RESTful API 的一种标准化方式。 它是 API 文档的格式化规范，帮助开发者清晰地定义和理解 API 的结构和行为。 而 OpenAPI 代码生成工具是一类基于 OpenAPI 规范自动生成代码的工具。 通过这些工具，开发者可以快速生成符合规范的客户端 SDK、服务器端代码或文档，而无需手动编写固定格式的代码。通过这些工具加可以重复代码的编写，让开发者更专注于业务逻辑的实现。 和 3.0）的情况下自动生成 API 客户端库（SDK 生成）、服务器存根、文档和配置。 小结 OpenAPI 代码生成工具是现代 API 开发不可或缺的加速器。它们通过自动化生成代码、文档以及样板，让开发者专注于业务逻辑的创新。
1.7K107编辑于 2025-01-04- 来自专栏Hugo博客
APIDoc自动生成接口文档
要是此时有个文档化的说明那就轻松多啦，现在后端流行的文档生成利器有Swagger，它虽然方便，但是也有弊端得写在的后台的代码中，而且启动整个后台项目才能访问。 环境，然后就是安装下APIDoc模块，参考命令如下： 1 npm install apidoc -g 工程配置文件 接下来创建个工程文件夹，并入个工程的配置文件，参考如下： 1 2 3 4 5 参考如下： hello-api.java 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 } */ /** * @apiDefine AccessKey * * @apiHeader {String} access-key 加密密钥: 当前日期+指定字符串的32位MD5加密字符串 * ] * } * * @apiUse Suc200 * * @apiUse Err400 * */ 生成接口文档 最后我们生成接口文档只需要一句简单的命令即可
53810编辑于 2024-11-20 - 来自专栏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 - 来自专栏国产
YApi自动生成接口文档
的官网下载，安装的话一直下一步下一步就行了npm 安装 YApi在终端里运行安装后会启动 yarpi server ，端口号是 9090部署 Yapi然后需要部署一下，这样才能在本地访问 Yapi 文档点击 可以记起来本地运行 YApi进到 Yapi-cli目录，运行这个时候浏览器的 3000 端口会运行 YApi 文档跨域插件如果想要在浏览器 YApi 访问到本地接口，需要安装 Yapi 提供的谷歌插件~
1K20编辑于 2023-05-06 - 来自专栏全栈开发那些事
用IDEA生成javadoc文档
文章目录 一、前言 二、IDEA生成API的步骤 1、Tools->Genearte javaDoc 2、设置 1、参数解释: 2、生成文档 3、文档结构如下： 一、前言 javadoc是Sun javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。 二、IDEA生成API的步骤 1、Tools->Genearte javaDoc 2、设置 1、参数解释: locale:zh_CN：表示生成中文文档 encoding UTF-8:源代码使用UTF -8编码 charset UTF-8:表示生成的文本字符集使用UTF-8编码 windowtitle “title”:表示用浏览器打开时的窗口标题 2、生成文档 3、文档结构如下： 打开index.html 即可查看生成的API
2.1K21编辑于 2023-02-25 - 来自专栏C/C++基础
Gin 生成 Swagger 接口文档
生成的 docs 包 注册 Gin router 5.FAQ 参考文献 1.背景 后台服务通过接口（如 RESTful API）对外提供服务时，需要有明确的接口文档。 书写接口文档，我们可以手动书写，也可以采用工具自动生成。手动书写的问题在于接口协议变更后需要维护接口文档，效率低下。采用工具生成，不同的工具生成的接口文档风格不一，增加阅读者的理解成本。 因此，我们可以采用业界常用的 Swagger 为 RESTful API 生成可交互的接口文档。 本文以 Gin 框架为例，描述 Gin 中如何为接口生成 Swagger 文档。 可通过编写 yaml 和 json 来实现接口的文档化，并且可以进行测试等工作。 通过 Swagger 可以方便地生成接口文档，方便前端进行查看和测试。 关于最终的文档效果，可参见官方示例 Swagger Petstore。 5.FAQ （1）访问接口文档发生Failed to load API definition.错误。
2.9K30编辑于 2023-02-23 - 来自专栏逸鹏说道
【开源】文档生成工具 DocFX
OpenLiveWriter/issues/203 详细：http://dotnet.github.io/docfx/tutorial/docfx_getting_started.html 微软最近开源了全新的文档生成工具 DocFX，目前支持C＃和VB，类似JSDoc或Sphinx，可以从源代码中提取注释生成文档之外，而且还有语法支 持你加入其他的文件链接到API添加额外的说明，DocFX会扫描你的源代码和附加的文件为你生成一个完整的 Follow steps in #2, #3, #4 to use DocFX in command-line, IDE or .NET Core. 5.
1.4K40发布于 2018-04-11 - 来自专栏John Wong's Blog
整合JApiDocs生成接口文档
上一篇文章中介绍了使用Swagger生成接口文档，非常方便，功能也十分强大。如果非要说Swaager有什么缺点，想必就是注解写起来比较麻烦。如果我说有一款不用写注解，就可以生成文档的工具，你心动了吗？ 我们新建一个项目，然后随便写一个main方法，增加生成文档的配置，然后运行main方法。 API 文档所在目录 config.setAutoGenerate(Boolean.TRUE); // 配置自动生成 Docs.buildHtmlDocs(config); // 执行生成文档 三、编码规范 几乎不需要注释即可生成接口文档，仅有的几个注释我们也可以通过ide来自动生成。但是JApiDocs不具备Swagger在线调试功能。 下一篇： SpringBoot整合Swagger生成接口文档→
84620编辑于 2021-12-23
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号