展开

关键词

apidoc实现API文档自动生成

为什么我们要使用apidoc来自动化生成API文档?它有什么样的优势呢? apidoc可以根据注释自动生成api文档,我们只需要把注释按照apidoc语法来写,不需要手动写markdown。 安装apidoc依赖 我们先使用npm在全局安装apidoc,命令为: npm install -g apidoc ? 配置apidoc 配置apidoc一般有两种方式:创建apidoc.json文件或者在package.json中进行配置。我直接选择在package.json里面进行配置。 ? 当然apidoc不可能就这么简陋的几个参数,我在这里也不打算把所有参数尝试一遍,所以挂上apidoc文档地址,有需要可以自行查看: http://apidocjs.com/ 接下来,我们接口注释按照apidoc apidoc生成文档使用命令: apidoc -i router/ -o doc 命令解析:使用apidoc命令,-i后面跟着我们需要打包的接口文件夹,比如我所有接口文件都放置在router文件夹下

4.5K80

API文档自动生成工具:apiDoc

简介 ---- apiDoc 支持的编程语言非常非常多,包括 Javascript , Java , Go , PHP , C# , Python , Ruby , CoffeeScript , TypeScript 使用 ---- 安装: npm install apidoc -g 以下是官网的一个简单的示例: ? 命令行输入以下指令自动生成 API 文档: apidoc -i <输入文件位置> -o <输出文件位置> 再来看看上面这个例子自动生成的 API 文档的最终效果图: ? 结束 ---- 简单的介绍就这样吧,本文的目的纯粹就是推荐一下 apidoc 这个小工具,让我们更快速高效的产出 API 文档 ,至于 apidoc 的更多更详细的用法,参考官网即可(npm 或 github 上搜索 apidoc 第一个就是的),官网的介绍真的真的真的很好,你肯定看得懂。

80821
  • 广告
    关闭

    老用户专属续费福利

    云服务器CVM、轻量应用服务器1.5折续费券等您来抽!

  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    Web API 文档生成工具 apidoc

    这里,笔者想分享另一个 Web API 文档生成工具 apidocapidoc 是通过源码中的注释来生成 Web API 文档。因此,apidoc 对现有代码可以做到无侵入性。 npm install apidoc -g 接着,我们还需要添加 apidoc.json 文件到项目工程的根目录下。 apiDoc browser title", "url" : "https://api.github.com/v1" } 这里,笔者主要演示 Java 注释如何和 apidoc 结合使用。 这里,我们用自己的项目工程的根目录替代 myapp/,用需要生成文档的地址替代 apidoc/。 apidoc -i myapp/ -o apidoc/ 例如,笔者的配置是这样的。 apidoc -i myapp/ -o apidoc/ 生成的页面,如下所示。 ?----

    73830

    apiDoc构建源代码注释的接口文档 原

    二、安装apidoc 1、输入命令: npm install apidoc –g ?  2、Win+R输入cmd,进行查看安装状态是否成功。 ? 到此安装工作已经完成。 构建 ? 配置(apidoc.json) apidoc.json项目中的可选项root dir包含有关项目的常用信息,如标题,简短说明,版本和配置选项,如页眉/页脚设置或模板特定选项。 If no apidoc.json with the field exists, then apiDoc try to determine the the value from package.json If no apidoc.json with the field exists, then apiDoc try to determine the the value from package.json apiDoc-PARAMS @api @api {method} path [title] 需要! 如果没有该指标,apiDoc解析器会忽略文档块。

    47020

    SpringBoot非官方教程 | 第十二篇:springboot集成apidoc

    首先声明下,apidoc是基于注释来生成文档的,它不基于任何框架,而且支持大多数编程语言,为了springboot系列的完整性,所以标了个题。 一、apidoc简介 apidoc通过在你代码的注释来生成api文档的。它对代码没有侵入性,只需要你写好相关的注释即可,并且它仅通过写简单的配置就可以生成高颜值的api接口页面。 二、准备工作 安装完node.js安装api.doc,它的项目源码:https://github.com/apidoc/apidoc 。 输命令: apidoc -i chapter4/ -o apidoc/ -i 输入目录 -o 输出目录 chapter4是我的工程名。 可以看到在apidoc目录生成了很多文件: ? 五、参考资料 apidoc apidocjs.com 使用apidoc 生成Restful web Api文档

    63470

    API文档自动生成续:活用 GitHub Pages

    本篇文章为上篇「 API 文档自动生成工具 apiDoc 」的续篇,建议阅读完上篇后再阅读本篇。 序言 ---- 上篇文章介绍了一个 API 文档自动生成的小工具「 apidoc 」,但是最终生成的是包括了html、css 样式等在内静态文件,虽然说自己在本地可以通过浏览器预览 index.html API 文档部署实操 ---- 1、新建一个 git 库,使用「 apidoc 」 自动生成 API 文档相关的静态文件并将其文件夹命名为 docs 并置于 git 库的根目录下 : apidoc -

    50231

    不想用 Swagger?可以试试这个神器!

    完整的示例项目,可见 https://github.com/YunaiV/SpringBoot-Labs/tree/master/lab-24/lab-24-apidoc-japidocs 地址,代码如下图所示 JApiDocs 自定义了 @ApiDoc 和 @Ignore 注解,用于针对指定接口,进行自定义的配置。下面,我们来瞅一瞅哦。 3.1 @ApiDoc 注解 @ApiDoc 注解,声明在接口方法上,通过它的四个属性,进行灵活配置。 result 属性:直接声明返回结果的类型。如果你声明了,将会覆盖方法返回结果的类型。 @ApiDoc 注解还有一个作用,声明该接口需要导出文档。 具体的使用示例如下: // 示例一 @ApiDoc(result = AdminVO.class, url = "/api/v1/admin/login2", method = "post") //

    44510

    告别“丝袜哥”,推荐这几个在线文档生成神器!

    6 apidoc github地址:https://github.com/apidoc/apidoc 开源协议:MIT License Star: 8.7k 开发语言:javascript 用户:未知 推荐指数:★★★★☆ 示例地址:https://apidocjs.com/example/#api-User apidoc是一个简单的 RESTful API 文档生成工具,它从代码注释中提取特定格式的内容生成文档 支持诸如 Go、Java、C++、Rust 等大部分开发语言,具体可使用 apidoc lang 命令行查看所有的支持列表。 apidoc 拥有以下特点: 跨平台,linux、windows、macOS 等都支持; 支持语言广泛,即使是不支持,也很方便扩展; 支持多个不同语言的多个项目生成一份文档; 输出模板可自定义; 根据文档生成 个人建议:这种在线文档生成工具提供了另外一种思路,swagger是在代码中加注解,而apidoc是在注解中加数据,代码嵌入性更小,推荐使用。

    10330

    四、mongoose的使用

    return res; }) .catch((err) => { console.log(err); return null; }); }; apiDoc 的使用 1.安装模块(仅一次) npm install apidoc -g 2.在项目根目录创建apidoc.json文件(仅一次) { "name": "example", "version": "0.1.0", "description": "apiDoc basic example", "title": "Custom apiDoc browser title", "url" : "https 每页显示条数 * * @apiSuccess {String} meta 状态码&提示信息 * @apiSuccess {String} data 数据 */ 4.生成接口文档(N次) apidoc

    42920

    window下yii2安装步奏

    composer create-project --prefer-dist --stability=dev yiisoft/yii2-app-advanced E:/apiweb/bootstrap/apidoc 注:E:/apiweb/bootstrap/apidoc是程序的目录,建议写全目录 之后等待很长时间,注意还需要书写github上的token,具体获取方法自行查询。 完成到此已经基本安装完成,下面步骤是初始化 先进入你的安装的项目目录 找到init脚本 1、执行init脚本 2、选择0开发环境,1生成环境 3、是否确定:yes 安装完后通过访问:/apidoc/frontend

    4510

    JApiDocs(自动生成接口文档神器)

    4、高级配置 (1)@ApiDoc a.实现 JApiDocs 默认只导出声明了@ApiDoc的接口,我们前面通过设置config.setAutoGenerate(Boolean.TRUE) 来解除了这个限制 如果你不希望把所有的接口都导出,你可以把autoGenerate设置关闭,在相关Controller类或者接口方法上通过添加@ApiDoc来确定哪些接口需要导出。 url: 请求URL,扩展字段,用于支持非SpringBoot项目 method: 请求方法,扩展字段,用于支持非SpringBoot项目 例: @ApiDoc(result = AdminVO.class , url = "/api/v1/admin/login2", method = "post") stringResult 实例,在文档中将会自动格式化json字符串: @ApiDoc(stringResult 关闭自动生成config.setAutoGenerate(Boolean.FALSE),使用@ApiDoc 来一个个接口导出排查问题。 2、多模块找不到相关类源码?

    10020

    无需注解的 SpringBoot API文档生成神器!

    注解来声明返回类型,你可以参考@ApiDoc章节的相关配置内容。 高级配置 @ApiDoc JApiDocs 默认只导出声明了@ApiDoc的接口,我们前面通过设置 config.setAutoGenerate(Boolean.TRUE) 来解除了这个限制。 如果你不希望把所有的接口都导出,你可以把autoGenerate设置关闭,在相关Controller类或者接口方法上通过添加@ApiDoc来确定哪些接口需要导出。 当@ApiDoc声明在接口方法上的时候,它还拥有一些更灵活的设置,下面我们来看一下: result: 这个可以直接声明返回的对象类型,如果你声明了,将会覆盖SpringBoot的返回对象 url: 请求 URL,扩展字段,用于支持非SpringBoot项目 method: 请求方法,扩展字段,用于支持非SpringBoot项目 例子: @ApiDoc(result = AdminVO.class, url

    17110

    3秒集成API接口文档

    ); // 项目名称 config.setApiVersion("V1.0"); // 声明该API的版本 config.setDocsPath("D:\\apiDoc config.setAutoGenerate(Boolean.TRUE); // 配置自动生成 Docs.buildHtmlDocs(config); // 执行生成文档 启动项目 在ApiDoc

    33230

    求你别再用swagger了,给你推荐几个在线文档生成神器

    apidoc github地址:https://github.com/apidoc/apidoc 开源协议:MIT License Star: 8.7k 开发语言:javascript 用户:未知 推荐指数 apidoc 是一个简单的 RESTful API 文档生成工具,它从代码注释中提取特定格式的内容生成文档。 支持诸如 Go、Java、C++、Rust 等大部分开发语言,具体可使用 apidoc lang 命令行查看所有的支持列表。 apidoc 拥有以下特点: 跨平台,linux、windows、macOS 等都支持; 支持语言广泛,即使是不支持,也很方便扩展; 支持多个不同语言的多个项目生成一份文档; 输出模板可自定义; 根据文档生成 个人建议:这种在线文档生成工具提供了另外一种思路,swagger是在代码中加注解,而apidoc是在注解中加数据,代码嵌入性更小,推荐使用。

    1.4K20

    win7系统下安装yii2步奏

    composer create-project --prefer-dist --stability=dev yiisoft/yii2-app-advanced E:/apiweb/bootstrap/apidoc 注:E:/apiweb/bootstrap/apidoc是程序的目录,建议写全目录 之后等待很长时间,注意还需要书写github上的token,具体获取方法自行查询。 完成到此已经基本安装完成,下面步骤是初始化 先进入你的安装的项目目录 找到init脚本 1、执行init脚本 2、选择0开发环境,1生成环境 3、是否确定:yes 安装完后通过访问:/apidoc/frontend

    4920

    Swagger之外的选择

    "name": "string //用户名称", "age": "int //用户年龄" } } 最终,我们生成的接口文档,如下: [format,png] 四、高级配置 4.1 @ApiDoc 如果你不希望把所有的接口都导出,我们可以在配置中设置config.setAutoGenerate(Boolean.FALSE);然后再想要生成的接口上添加@ApiDoc。 @ApiDoc有以下三个属性: result: 这个可以直接声明返回的对象类型,如果你声明了,将会覆盖SpringBoot的返回对象 url: 请求URL,扩展字段,用于支持非SpringBoot项目 method: 请求方法,扩展字段,用于支持非SpringBoot项目 @ApiDoc(result = User.class, url = "/api/user/view", method = "post

    46810

    你还在用 swagger?试试这几款在线文档生成神器!!

    /apidoc/apidoc 开源协议:MIT License Star: 8.7k 开发语言:javascript 用户:未知 推荐指数:★★★★☆ 示例地址:https://apidocjs.com /example/#api-User apidoc 是一个简单的 RESTful API 文档生成工具,它从代码注释中提取特定格式的内容生成文档。 支持诸如 Go、Java、C++、Rust 等大部分开发语言,具体可使用 apidoc lang 命令行查看所有的支持列表。 最新面试题整理好了,点击Java面试库小程序在线刷题。 apidoc 拥有以下特点: 跨平台,linux、windows、macOS 等都支持; 支持语言广泛,即使是不支持,也很方便扩展; 支持多个不同语言的多个项目生成一份文档; 输出模板可自定义; 根据文档生成 个人建议:这种在线文档生成工具提供了另外一种思路,swagger是在代码中加注解,而apidoc是在注解中加数据,代码嵌入性更小,推荐使用。

    26520

    超简单-自动生成接口文档

    , 22)); } b.获取所有接口信息的接口 @GetMapping("/api/{type}") public ApiDoc admin(@PathVariable("type ") String type) { //是否打开文档功能 if (openApiDoc) { ApiDoc apiDoc = null; if (type.equals("admin")) { String packageName = "com.demo.web"; apiDoc

    1.2K10

    扫码关注腾讯云开发者

    领取腾讯云代金券