apidoc 自动化生成 api接口文档

傷城~ 2023-02-22 12:14 3阅读 0赞

### 手写api接口太麻烦. 学习了apidoc自动生成接口文档,这边做一下整理 ###

### 要用组件那就必须先安装 apidoc,做一下全局安装 ###

> npm install apidoc -g

### 新建配置文件apidoc.json ###

{ 
      "name": "test-server",
      "version": "1.0.0",
      "description": "测试API文档",
      "title": "test-server API",
      "url": "http://127.0.0.1:3000",
      "forceLanguage": "zh-cn"
    }

### 在要存放接口文档的目录下创建一个 apidoc 空目录,用来存放生成的接口文件,我是放在public目录下 ###

### 写api的接口注释 ,如上图右侧注释部分,相关解释可去官网 https://apidocjs.com 查看或者自己摸索一下 ###

/** * @api {post} /postUser 测试api * @apiDescription 测试api * @apiName text * @apiGroup User * @apiParam {string} account 用户账号 * @apiParam {string} password 用户密码 * @apiHeader {String} Authorization 用户授权token * @apiSuccess msg 返回消息 * @apiSuccessExample {json} Success-Response: * { code : 200, msg: '认证token成功', } * @apiSampleRequest http://127.0.0.1:3000/postUser * @apiVersion 1.0.0 */

### 最后一步就是生成api接口文档 ,在项目下执行命令:-i 指输入 对 routes目录下文件进行编译 -o指输出 输出到public/apidoc目录下 ###

> apidoc -i routes/ -o public/apidoc/

### 项目运行起来,在浏览器输入api接口文档的浏览地址,就能看到自动生成的接口文档了 ###

发表评论取消回复

表情：

评论列表（有 0 条评论，3人围观）

还没有评论，来说两句吧...

相关阅读

相关 apidoc 自动化生成 api接口文档

手写api接口太麻烦. 学习了apidoc自动生成接口文档,这边做一下整理要用组件那就必须先安装 apidoc,做一下全局安装 > npm install api

傷城~/ 2023年02月22日 12:14/ 0 赞/ 4 阅读

相关 Linux使用apidoc自动生成Restful web Api文档

apidoc简介 apidoc是一款可以有源代码中的注释直接自动生成api接口文档的工具，它几乎支持目前主流的所有风格的注释。支持的编程语言： 1. C\, Go

短命女/ 2023年02月08日 15:59/ 0 赞/ 302 阅读

相关 API文档、apiDoc、部分使用、指南、安装、配置

> 本文主要参考 > > > > [ApiDoc官方文档][ApiDoc] 安装 1. [安装node.js][node.js] 2. 安装apiDo

布满荆棘的人生/ 2022年12月28日 04:16/ 0 赞/ 261 阅读

相关生成接口文档

Swagger生成接口文档，no no no JApiDocs是一个无需额外注解、开箱即用的SpringBoot接口文档生成工具。编写和维护API文档这个事情，对于后端程

比眉伴天荒/ 2022年12月04日 09:17/ 0 赞/ 339 阅读

相关接口文档Swagger、knife4j和YApi、APIDOC

接口文档Swagger、knife4j和YApi、APIDOC功能对比图 <table> <thead> <tr> <th>API文档工具</th>

今天药忘吃喽~/ 2022年11月13日 06:22/ 0 赞/ 228 阅读

相关【ApiDoc】官方文档(翻译)

> 本文主要参考[ApiDoc官方文档][ApiDoc] apidoc简介 apidoc是一款可以有源代码中的注释直接自动生成api接口文档的工具，它几乎支持目前主流的

不念不忘少年蓝@/ 2022年05月21日 10:06/ 0 赞/ 337 阅读

相关 CodeIgniter+swagger实现 PHP API接口文档自动生成功能自动生成ci RESTFUL api接口文档

一、安装swagger 1、首先需要有composer，没有的自行百度安装 2、下载swagger，打开网站[https://packagist.org/package

﹏ヽ暗。殇╰゛Y/ 2022年04月02日 04:37/ 0 赞/ 464 阅读

相关 Apidoc生成Restful web Api文档

工具名称：apiDoc Git地址：[https://github.com/apidoc/apidoc][https_github.com_apidoc_apidoc]

小灰灰/ 2022年03月08日 06:28/ 0 赞/ 273 阅读

相关 linux 使用apidoc 生成Restful web Api文档

官方文档：[http://apidocjs.com/\example-basic][http_apidocjs.com_example-basic] 博客：[https://

朱雀/ 2022年03月06日 18:16/ 0 赞/ 285 阅读

相关 IDEA生成API接口文档

IDEA生成API接口文档第一步: ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR

灰太狼/ 2021年12月09日 02:39/ 0 赞/ 559 阅读