apiDoc教程（从入门到精通版、开发者API文档利器、全网最全讲解）

最新推荐文章于 2024-08-09 17:20:48 发布
最新推荐文章于 2024-08-09 17:20:48 发布
阅读量9.3k 收藏 32
点赞数 3
分类专栏： nodejs 文章标签： apiDoc Java api文档 API文档生成 自动化工具
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_32352777/article/details/102746237
版权

apiDoc教程目录

1、安装nodejs

2、安装apiDoc

3、创建apiDoc配置文件

4、在程序中使用apiDoc进行注释

apiDoc参数目录

@apiDefine

@apiDeprecated

@apiDescription

@apiError

@apiErrorExample

@apiExample

@apiGroup

@apiHeader

@apiHeaderExample

@apiIgnore

@apiName

@apiParam

@apiParamExample

@apiPermission

@apiPrivate

@apiSampleRequest

@apiSuccess

@apiSuccessExample

@apiUse

@apiVersion

5、@apiGroup兼容中文解决方法

6、apiDoc兼容Ajax json格式请求提交解决方法

7、生成API文档

市面上常用的API文档管理方式有apiDoc、Swagger2、DocClear。

Swagger2有一个比较明显的缺点：代码侵入，开启注解时会影响原本的系统性能。

同样DocClear也有一个比较明显的缺点：DocClear本身只是一个接口信息管理平台，所有的接口信息需要开发人员在平台内进行录入。

apiDoc作为API文档工具是一款通过源代码中的API注释创建文档，支持Java、JS、PHP、Tython等语言，没有Swagger2那样代码侵入，而是通过apiDoc的程序对我们的源代码文件进行扫描，获取文件内的apiDoc注释信息来创建API文档，进而生成静态的API文档页面。接下来就从头到尾给大家讲解一下apiDoc如何使用。

 

1、安装nodejs

具体请看这篇文章：node.js安装| 解决npm下载慢 | npm在项目开发中常用命令 | dependencies与devDependencies的区别 | npm build 打包配置

2、安装apiDoc

安装配置好nodejs后，在命令行界面输入：

npm install apidoc -g

3、创建apiDoc配置文件

在你的项目根目录下新建apidoc.json文件，该文件描述了项目对外提供接口的概要信息如名称、版本、描述、文档打开时浏览器显示标题和接口缺省访问地址。

实例文件：

{
  "name": "api-doc",
  "version": "0.1.0",
  "description": "接口文档描述",
  "title": "接口文档标题",
  "url" : "http://127.0.0.1:8091",
  "sampleUrl" : "http://127.0.0.1:8091",
  "order": [
    "系统",
    "用户",
    "角色",
    "部门",
  ],
  "template": {
    "forceLanguage": "zh_cn"
  }
}

注：1、apidoc.json文件不是必须创建在项目中，而是为了方便操作。

2、若没有配置sampleUrl参数，apiDoc最终生成的API文档内将没有测试api方法。

以下是参数说明

 

名称描述
name项目名称。
如果apidoc.json该字段不存在，则apiDoc尝试从确定值package.json。
version项目的版本。
如果apidoc.json该字段不存在，则apiDoc尝试从确定值package.json。
description项目简介。
如果apidoc.json该字段不存在，则apiDoc尝试从确定值package.json。
title浏览器标题文字。
urlapi路径的前缀（端点），例如 https://api.github.com/v1
sampleUrl如果设置，则将显示用于测试api方法（发送请求）的表单。有关更多详细信息，请参见@apiSampleRequest。
header
    title包含的header.md文件的导航文本。
    filename包含的header.md文件的文件名（markdown-file）。
footer
    title包含的footer.md文件的导航文本。
    filename包含的footer.md文件的文件名（markdown文件）。
order用于排序输出的api名称/组名称的列表。未定义的名称将自动显示在最后。 
"order": [
  "Error",
  "Define",
  "PostTitleAndError",
  "PostError"
]

模板特定设置

以下设置特定于apiDoc的默认模板。

名称类型描述
template
    forceLanguageString禁用浏览器语言自动检测并设置特定的语言环境。
范例：de，en。
查看可用的语言环境。 
    withCompareBoolean启用与旧版api的比较。默认：true
    withGeneratorBoolean在页脚输出生成器信息。默认：true
    jQueryAjaxSetupObject设置Ajax请求的默认值。

4、在程序中使用apiDoc进行注释

这里已Java代码为例：

先给一个代码示例，Java项目中无需添加任意依赖，只需要按照apiDoc规定的方式进行注释即可，换句话说就是把原本JavaDoc的注释形式转化为apiDoc的注释形式即可。

    /**
     * @api {post} /urlDemo 示例接口名称
     * @apiGroup 系统
     * @apiVersion 0.0.1
     * @apiDescription 示例接口描述
     * @apiParam {String} param1 请求参数1
     * @apiParam {Object} param2 请求参数2（JSON数据）
     * @apiParam {String} param2.name 请求参数3（属于请求参数2的一个属性）
     * @apiParam {Number} [param4] 请求参数4
     * @apiUse ResponseBody
     * @apiSuccess {Object} data响应数据描述
     *
     * @apiError _SESSION_EXPIRED 会话已过期
     * @apiErrorExample {json} _SESSION_EXPIRED
     *      HTTP/1.1 200 OK
     *     {
     *       "resultCode": -13,
     *       "resultMsg": "会话已过期",
     *       data: null
     *     }
     * @apiUse ResponseBody
     */
    @PostMapping(value = "/urlDemo")
    public void urlDemo (@RequestBody Map<String, String> params){
        // ..
    }

apiDoc参数目录

@api
@apiDefine
@apiDeprecated
@apiDescription
@apiError
@apiErrorExample
@apiExample
@apiGroup
@apiHeader
@apiHeaderExample
@apiIgnore
@apiName
@apiParam
@apiParamExample
@apiPermission
@apiPrivate
@apiSampleRequest
@apiSuccess
@apiSuccessExample
@apiUse
@apiVersion

 

@apiDefine

@apiDefine name [title]
                     [description]

定义要嵌入到文档块中@api或api函数之类的文档文档块@apiPermission。

@apiDefine 每个方块只能使用一次

通过使用@apiUse已定义的块，将导入该块，或使用名称和标题和说明。

用法： @apiDefine MyError

名称描述
名称块/值的唯一名称。可以定义
不同的相同名称@apiVersion。
标题可选简短标题。仅用于命名函数，例如@apiPermission或@apiParam (name)。
说明可选详细说明从下一行开始，可以使用多行。仅用于命名函数，如@apiPermission。

例：

/**
 * @apiDefine MyError
 * @apiError UserNotFound The <code>id</code> of the User was not found.
 */

/**
 * @api {get} /user/:id
 * @apiUse MyError
 */
/**
 * @apiDefine admin User access only
 * This optional description belong to to the group admin.
 */

/**
 * @api {get} /user/:id
 * @apiPermission admin
 */

 

@apiDeprecated

@apiDeprecated [text]

将API方法标记为不推荐使用

用法： @apiDeprecated use now (#Group:Name).

名称描述
文本多行文字。

例：

/**
 * @apiDeprecated
 */

/**
 * @apiDeprecated use now (#Group:Name).
 *
 * Example: to set a link to the GetDetails method of your group User
 * write (#User:GetDetails)
 */

@apiDescription

@apiDescription text

API方法的详细说明。

用法： @apiDescription This is the Description.

名称描述
文本多行描述文字。

例：

/**
 * @apiDescription This is the Description.
 * It is multiline capable.
 *
 * Last line of Description.
 */

@apiError

@apiError [(group)] [{type}] field [description]

错误返回参数。

用法： @apiError UserNotFound

名称描述
（组）可选所有参数将按此名称分组。
如果没有组，Error 4xx则设置默认值。
您可以使用@apiDefine设置标题和描述。
{type}可选返回类型，例如{Boolean}， {Number}， {String}，{Object}，{String[]}（字符串数组），...
领域返回标识符（返回的错误代码）。
说明可选字段说明。

例：

/**
 * @api {get} /user/:id
 * @apiError UserNotFound The <code>id</code> of the User was not found.
 */

@apiErrorExample

@apiErrorExample [{type}] [title]
                 example

错误返回消息的示例，以预格式化的代码输出。

用法： @apiErrorExample {json} Error-Response:
This is an example.

名称描述
输入可选响应格式。
标题可选该示例的简短标题。
例详细的例子，多行功能。

例：

/**
 * @api {get} /user/:id
 * @apiErrorExample {json} Error-Response:
 *     HTTP/1.1 404 Not Found
 *     {
 *       "error": "UserNotFound"
 *     }
 */

@apiExample

@apiExample [{type}] title
            example

API方法使用示例。输出为预格式化的代码。

在端点描述的开头将其用作完整示例。

用法： @apiExample {js} Example usage:
This is an example.

名称描述
输入可选代码语言。
标题该示例的简短标题。
例详细的例子，多行功能。

例：

/**
 * @api {get} /user/:id
 * @apiExample {curl} Example usage:
 *     curl -i http://localhost/user/4711
 */

@apiGroup

@apiGroup name

应该始终使用。

定义方法文档块属于哪个组。组将用于生成的输出中的主导航。不需要结构定义@apiGroup。

用法： @apiGroup User

名称描述
名称组名。也用作导航标题。

例：

/**
 * @api {get} /user/:id
 * @apiGroup User
 */

@apiHeader

@apiHeader [(group)] [{type}] [field=defaultValue] [description]

描述传递给您的API标头的参数，例如用于授权。

与@apiParam类似的操作，仅输出在参数之上。

用法： @apiHeader (MyHeaderGroup) {String} authorization Authorization value.

名称描述
（组）可选所有参数将按此名称分组。
如果没有组，Parameter则设置默认值。
您可以使用@apiDefine设置标题和描述。
{type}可选参数类型，例如{Boolean}， {Number}， {String}，{Object}，{String[]}（字符串数组），...
领域变量名。
[领域]带括号的字段名称将变量定义为可选。
= defaultValue可选参数默认值。
说明可选字段说明。

例子：

/**
 * @api {get} /user/:id
 * @apiHeader {String} access-key Users unique access-key.
 */

@apiHeaderExample

@apiHeaderExample [{type}] [title]
                   example

参数请求示例。

用法： @apiHeaderExample {json} Request-Example:
{ "content": "This is an example content" }

名称描述
输入可选请求格式。
标题可选该示例的简短标题。
例详细的例子，多行功能。

例：

/**
 * @api {get} /user/:id
 * @apiHeaderExample {json} Header-Example:
 *     {
 *       "Accept-Encoding": "Accept-Encoding: gzip, deflate"
 *     }
 */

@apiIgnore

@apiIgnore [hint]

将其放在一个块的顶部。

@apiIgnore不会解析的块。如果您在源代码中留下了过时的方法或未完成的方法，并且不想将其发布到文档中，则这很有用。

用法： @apiIgnore Not finished Method

名称描述
提示可选有关为何应忽略此块的简短信息。

例：

/**
 * @apiIgnore Not finished Method
 * @api {get} /user/:id
 */

@apiName

@apiName name

应该始终使用。

定义方法文档块的名称。名称将用于生成的输出中的子导航。不需要结构定义@apiName。

用法： @apiName GetUser

名称描述
名称方法的唯一名称。@apiVersion可以定义不同的相同名称。
格式：方法 + 路径（例如Get + User），只有建议，您可以根据需要命名。
也用作导航标题。

例：

/**
 * @api {get} /user/:id
 * @apiName GetUser
 */

@apiParam

@apiParam [(group)] [{type}] [field=defaultValue] [description]

描述传递给您的API方法的参数。

用法： @apiParam (MyGroup) {Number} id Users unique ID.

对于嵌套参数，请使用方括号符号（[]）。

名称描述
（组）可选所有参数将按此名称分组。
如果没有组，Parameter则设置默认值。
您可以使用@apiDefine设置标题和描述。
{type}可选参数类型，例如{Boolean}，{Number}，{String}，{Object}，{String[]}（字符串数组），...
{type {size}}可选有关变量大小的信息。
{string{..5}}最多包含5个字符的字符串。
{string{2..5}}最小的字符串 2个字符，最多5个字符。
{number{100-999}}100到999之间的数字。
{type = allowedValues}可选有关变量的允许值的信息。
{string="small"}一个只能包含单词“ small”（常量）的字符串。
{string="small","huge"}一个可以包含单词“ small”或“ huge”的字符串。
{number=1,2,3,99}一个数字，允许的值为1、2、3和99。

可以与大小组合：
{string {..5}="small","huge"}一个字符串，最多包含5个字符，并且仅包含单词“ small”或“ huge”。
领域栏位名称。
[领域]带括号的字段名称将变量定义为可选。
字段[nestedField]强制嵌套字段。
= defaultValue可选参数默认值。
说明可选字段说明。

例子：

/**
 * @api {get} /user/:id
 * @apiParam {Number} id Users unique ID.
 */

/**
 * @api {post} /user/
 * @apiParam {String} [firstname]       Optional Firstname of the User.
 * @apiParam {String} lastname          Mandatory Lastname.
 * @apiParam {String} country="DE"      Mandatory with default value "DE".
 * @apiParam {Number} [age=18]          Optional Age with default 18.
 *
 * @apiParam (Login) {String} pass      Only logged in users can post this.
 *                                      In generated documentation a separate
 *                                      "Login" Block will be generated.
 *
 * @apiParam {Object} [address]         Optional nested address object.
 * @apiParam {String} [address[street]] Optional street and number.
 * @apiParam {String} [address[zip]]    Optional zip code.
 * @apiParam {String} [address[city]]   Optional city.
 */

@apiParamExample

@apiParamExample [{type}] [title]
                   example

参数请求示例。

用法： @apiParamExample {json} Request-Example:
{ "content": "This is an example content" }

名称描述
输入可选请求格式。
标题可选该示例的简短标题。
例详细的例子，多行功能。

例：

/**
 * @api {get} /user/:id
 * @apiParamExample {json} Request-Example:
 *     {
 *       "id": 4711
 *     }
 */

@apiPermission

@apiPermission name

输出权限名称。如果名称是@apiDefine在生成的文档中定义的，则包括其他标题和描述。

用法： @apiPermission admin

名称描述
名称权限的唯一名称。

例：

/**
 * @api {get} /user/:id
 * @apiPermission none
 */

@apiPrivate

@apiPrivate

将API定义为私有的，以允许创建两个API规范文档：一个排除私有API，而包括私有API。

用法： @apiPrivate

命令行用法来排除/包括私有API： --private false|true

例：

/**
 * @api {get} /user/:id
 * @apiPrivate
 */

@apiSampleRequest

@apiSampleRequest url

将此参数与apidoc.json配置参数sampleUrl结合使用。

如果sampleUrl设置为，则所有方法都将具有api测试表单（将附加@api的端点）。
如果不使用sampleUrl，则只有的方法@apiSampleRequest将具有形式。

如果@apiSampleRequest url在方法块中设置了if ，则此url将用于请求（当它以http开头时，它将覆盖sampleUrl）。

如果sampleUrl设置为if 并且您不想要带有测试表单的方法，则将其添加@apiSampleRequest off到documentation块中。

用法： @apiSampleRequest http://test.github.com

名称描述
网址网址到您的测试API服务器。

覆盖配置参数sampleUrl并附加@api url：
@apiSampleRequest http://www.example.com

在@api url之前添加前缀：
@apiSampleRequest /my_test_path

如果设置了配置参数sampleUrl，则禁用api测试：
@apiSampleRequest off

例子：

这会将api请求发送到http://api.github.com/user/:id

Configuration parameter sampleUrl: "http://api.github.com"
/**
 * @api {get} /user/:id
 */

这会将api请求发送到http://test.github.com/some_path/user/:id。
它将覆盖sampleUrl。

Configuration parameter sampleUrl: "http://api.github.com"
/**
 * @api {get} /user/:id
 * @apiSampleRequest http://test.github.com/some_path/
 */

这会将api请求发送到http://api.github.com/test/user/:id。
它扩展了sampleUrl。

Configuration parameter sampleUrl: "http://api.github.com"
/**
 * @api {get} /user/:id
 * @apiSampleRequest /test
 */

这将禁用此api方法的api请求。

Configuration parameter sampleUrl: "http://api.github.com"
/**
 * @api {get} /user/:id
 * @apiSampleRequest off
 */

这会将api请求发送到http://api.github.com/some_path/user/:id
，因为未设置sampleUrl，所以仅激活此方法的请求。

Configuration parameter sampleUrl is not set
/**
 * @api {get} /user/:id
 * @apiSampleRequest http://api.github.com/some_path/
 */

@apiSuccess

@apiSuccess [(group)] [{type}] field [description]

成功返回参数。

用法： @apiSuccess {String} firstname Firstname of the User.

名称描述
（组）可选所有参数将按此名称分组。
如果没有组，Success 200则设置默认值。
您可以使用@apiDefine设置标题和描述。
{type}可选返回类型，例如{Boolean}， {Number}， {String}，{Object}，{String[]}（字符串数组），...
领域返回标识符（返回成功代码）。
说明可选字段说明。

例：

/**
 * @api {get} /user/:id
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */

的示例(group)，@apiSuccess更多组示例：

/**
 * @api {get} /user/:id
 * @apiSuccess (200) {String} firstname Firstname of the User.
 * @apiSuccess (200) {String} lastname  Lastname of the User.
 */

对象示例：

/**
 * @api {get} /user/:id
 * @apiSuccess {Boolean} active        Specify if the account is active.
 * @apiSuccess {Object}  profile       User profile information.
 * @apiSuccess {Number}  profile.age   Users age.
 * @apiSuccess {String}  profile.image Avatar-Image.
 */

数组示例：

/**
 * @api {get} /users
 * @apiSuccess {Object[]} profiles       List of user profiles.
 * @apiSuccess {Number}   profiles.age   Users age.
 * @apiSuccess {String}   profiles.image Avatar-Image.
 */

@apiSuccessExample

@apiSuccessExample [{type}] [title]
                   example

成功返回消息的示例，以预格式化的代码输出。

用法： @apiSuccessExample {json} Success-Response:
{ "content": "This is an example content" }

名称描述
输入可选响应格式。
标题可选该示例的简短标题。
例详细的例子，多行功能。

例：

/**
 * @api {get} /user/:id
 * @apiSuccessExample {json} Success-Response:
 *     HTTP/1.1 200 OK
 *     {
 *       "firstname": "John",
 *       "lastname": "Doe"
 *     }
 */

@apiUse

@apiUse name

包括一个带有@apiDefine定义的块。如果与@apiVersion相同或最接近的前任产品一起使用，则将包括在内。

用法： @apiUse MySuccess

名称描述
名称定义块的名称。

例：

/**
 * @apiDefine MySuccess
 * @apiSuccess {string} firstname The users firstname.
 * @apiSuccess {number} age The users age.
 */

/**
 * @api {get} /user/:id
 * @apiUse MySuccess
 */

@apiVersion

@apiVersion version

设置文档块的版本。版本也可以在中使用@apiDefine。

具有相同组和名称但不同版本的块可以在生成的输出中进行比较，因此您或前端开发人员可以追溯自上一个版本以来API中的更改。

用法： @apiVersion 1.6.2

名称描述
版本支持简单版本控制（major.minor.patch）。

例：

/**
 * @api {get} /user/:id
 * @apiVersion 1.6.2
 */

5、@apiGroup兼容中文解决方法

apiDoc的@apiGroup是默认不支持中文需要我们单独处理一下：

1.找到安装目录中api_group.js
centos安装目录：/usr/lib/node_modules/apidoc/node_modules/apidoc-core/lib/workers/api_group.js
window安装目录：C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers\api_group.js
2.注释代码
将83行的替换代码注释：
//group = group.replace(/[^\w]/g, '_');

6、apiDoc兼容Ajax json格式请求提交解决方法

1.找到安装目录中的send_sample_request.js
[前缀参考前文]\apidoc\template\utils
2.将96行的ajax form表单的提交请求，替换成下面的这个：
      // send AJAX request, catch success or error callback
      $.ajax({
        url: url,
        dataType: "json",
        contentType: "application/json",
        data: JSON.stringify(param),
        headers: header,
        type: type.toUpperCase(),
        success: displaySuccess,
        error: displayError
      });

7、生成API文档

在第三节创建的apiDoc.json的目录位置打开命令行窗口，执行：

apidoc -i [项目完整路径] -o apidoc/

例如：

apidoc -i G:/Project/demo/ -o apidoc/

参数说明：

参数描述
-f，--file-filtersRegEx-Filter选择要解析的文件（可以使用许多-f）。默认.cs .dart .erl .go .java .js .php .py .rb .ts。

示例（仅解析.js和.ts文件）：
apidoc -f ".*\\.js$" -f ".*\\.ts$"
-i, --input输入/源目录名。项目文件的位置。

例：
apidoc -i myapp/
-o, --output输出目录名。放置生成的文档的位置。

例：
apidoc -o apidoc/
-t, --template使用模板输出文件。您可以创建和使用自己的模板。

例：
apidoc -t mytemplate/
-e, --exclude输出文件时排除文件。

例：
apidoc -e asset/

 

在项目中某些目录不需要扫描，API生成，则需要使用-e参数

例如：

apidoc -i G:/Project/demo/ -o apidoc/  -e web

命令执行成功后，将会输出：

{"message":"Done.","level":"info"}

此时我们可以在当前目录下看到，多了一个apidoc的文件夹，这个文件就是apiDoc生成的API文档。

打开文件夹可以看到类似如下内容：

此时我们打开index.html就可以看到我们通过在接口上添加的注释所生成的API文档了。

打开网页，可以看到如下内容：

通过网页内容，我们可以看到页面内有接口接口名称、接口描述、请求类型、接口参数说明、接口成功响应内容、接口异常内容、测试接口入口等内容。

这时我们就可以很方便的进行API查阅和测试了。

注：如果接口发生变化，只需要修改对应的代码注释再次通过命令进行API文档生成即可。

 

参考文档：apiDoc官网

 

手编不易，转载参考请注明来源：apiDoc教程（从入门到精通版、开发者API文档利器、全网最全讲解）。

欢迎大家点赞、留言

昌杰的攻城狮之路
关注
专栏目录
好用的ApiDoc使用教程
zmjheart的博客
05-01 808
一、官网 ApiDoc官网 二、安装教程 1.安装nodejs。去node.js官网下载安装一个nodejs 2.安装apidoc：命令行输入：npm install apidoc -g 三、使用教程 1.在你的项目的根目录下，创建名为apidoc.json的文件 { "name": "example", "version": "0.1.0", "description": "apiD...
apidoc入门教程
Evan Liu的博客
09-18 286
apidoc入门教程前言介绍安装 检查node环境 检查npm包管理工具 安装apidoc 参数列表 前言   在前后端分离项目的开发过程中，一份完整的API文档显得至关重要，今天给大家安利一款轻量级的、跨平台的、适用于大部分流行语言（包括但不限于Java、Python、javascript）的、适用于 RestFul风格的API文档生成工具—apidoc 个人认为超级好用???? 介绍 apidoc官网传送门：https://apidocjs.com/   官网说明是：RESTful Web API 的内
apiDoc – RESTful Web API 文档
测试
04-16 468
关于 apidoc 是一个简单的RESTfulAPI文档生成工具，它从代码注释中提取特定格式的内容，生成文档。目前已支持以下语言：C#、C/C++、D、Erlang、Go、Groovy、Java、Javascript、Pascal/Delphi、Perl、PHP、Python、Rust、Ruby、Scala 和 Swift。 apidoc 拥有以下特点： ...
常用API的介绍和基本使用
最新发布
weixin_60564529的博客
08-09 1129
什么是API​ API (Application Programming Interface) ：应用程序编程接口java中的API​ 指的就是 JDK 中提供的各种功能的 Java类，这些类将底层的实现封装了起来，我们不需要关心这些类是如何实现的，只需要学习这些类如何使用即可，我们可以通过帮助文档来学习这些API如何使用。打开帮助文档找到索引选项卡中的输入框在输入框中输入Random看类在哪个包下看类的描述看构造方法看成员方法。
webApi文档好帮手-apidoc使用教程
weixin_33781606的博客
09-18 153
apidoc官网 ： http://apidocjs.com/ apidoc工具说明： http://apidoc.tools/ 在开发后台接口的过程中，我们肯定要提供一份api接口文档给终端app。 目前大多数的app的接口请求应该都是http+json的方式。 但是一直苦于做不出份漂亮的api文档，用word写，也太丑了。。怎么才能做出一份像腾讯、新浪微博等各种开放api平台那样漂亮的api文...
apidoc使用教程-很好用的一款读取注释生成文档工具
MClink的博客
02-15 1839
一.apidoc说明 1.如何安装 前提：确保已安装node.js 使用npm进行apidoc安装&nbsp;&nbsp; node.js下载 npm install apidoc -g 2.如何使用 1)建立配置文件 分两种情况： ①已经有package.json文件 { "name": "文档名称", "version": "0.1.0", "description"
apidoc简单教程
chaoge的博客
07-14 1111
apidoc简单使用教程
如何使用apiDoc
链珠的博客
03-24 518
最近对后端同学的接口文档很感兴趣，抽空学习了下~ 1、安装nodeJs 2、安装和使用apiDoc 新建一个文件夹，打开终端： npm install apidoc -g 把api注释写在你要调用的接口上方 具体含义参考官网： https://apidocjs.com/#param-api-sample-request @api @api {method} path [title] 接口方法、路径和名称 @apiGroup @apiGroup nam...
apidoc生成api文档
04-10
apidoc是一款强大的API文档生成工具，它允许开发者通过在代码注释中添加特定的指令来自动构建清晰、结构化的API文档。这个工具极大地简化了API文档的维护过程，确保了文档与代码的一致性，降低了团队协作中的沟通...
pandora-apidoc：pandora.com API文档
02-04
首先，"pandora-apidoc"是一个详细的文档集合，旨在为开发者提供关于Pandora API的全面信息。API文档是任何开发者在使用新接口时的首要参考，它详述了各种端点、参数、请求和响应格式，以及如何正确地进行身份验证和...
java web api文档生成工具.继Swagger以后,又一个用法更简单的APIDoc生成中间件
12-04
Java Web API文档生成工具在现代软件开发中扮演着至关重要的角色，它们帮助开发者轻松地创建、管理和分享API接口的文档。Swagger是这类工具中的佼佼者，但有时其使用方式可能相对复杂，需要编写大量的注解。而"java ...
apiDoc：这是一个简单的开源API文档项目
02-17
API文档 概览 api-doc是一个简单高效的api接口文档和项目文档记录应用程序。支持markdown记录项目文档，极大的方便了前后台对于接口文档和项目文档的查看，使用。采用PHP编写，前端使用VUE编写。 鸣谢列表 感谢JetBrains提供的免费IDE支持！ 相关： 架构 该项目为前后台分离项目。 php7.2（Yii2框架）提供介入能力 vue2.0作为前端开发框架 mysql5.7作为数据库 文件夹 front前置文件夹 backend初始文件夹 这两个文件夹下还各包含一个README.MD，为各自的其他说明。 安装方法 进入front（前端）文件夹，首先执行yarn install安装依赖，然后执行yarn serve 进入backend（初始）文件夹，执行composer install安装依赖，然后执行php yii serve --port = 1000 数据库初始化
api-docs
03-06
api-docs
API-docs:API文档
03-08
API文档
api-docs:API文档
03-05
api-docs API文档
apiDoc:RESTful Web API 文档生成器-开源
08-07
apiDoc 根据源代码中的 API 注释创建文档。 apiDoc 使您能够将版本号附加到 API，以便您可以轻松跟踪版本之间的更改。 创建目录 myapp/ 中所有文件的 apiDoc，使用目录 mytemplate/ 中的模板并将所有输出放入目录 ...
apiDoc-RESTfulwebAPI文档生成器
08-09
**apiDoc：RESTful web API 文档生成器** 在当今的软件开发中，API（Application Programming Interface）扮演着至关重要的角色。它允许不同的系统和服务之间进行数据交换和功能调用，使得开发人员能够构建分布式、...
apidoc的使用
weixin_52022584的博客
08-01 554
②验证安装是否成功：③配置apidoc.json文件在项目的根目录建立apidoc.json文件。
apiDoc使用指南
weixin_43395106的博客
09-17 769
apiDoc使用指南： 安装： 1: 需要先安装node.js(安装node.js请浏览相关博客) 2: node.js安装完成后使用命令: npm install apidoc -g 配置： 在你的项目根路径下新建apidoc.json文件,该文件描述了项目对外提供接口的概要信息如名称,版本,描述文档打开时浏览器显示标题和接口缺省访问地址. 使用样例： /** * * @apiDefine RkNotFoundException * * @apiError RkNotFoundExceptio
javaapi文档中文版
05-30
Java API文档中文版可以在Oracle官网上找到。你可以在以下网址上找到Java SE的文档：https://www.oracle.com/java/technologies/javase-downloads.html 在页面上，你需要选择Java版本，然后点击“Documentation”下的链接。在文档页面上，你可以选择“API文档”来查看Java API的文档，同时你可以切换到中文版。 此外，还有一些第三方网站提供Java API文档的中文翻译，比如阿里云的Java开发者手册：https://developer.aliyun.com/topic/java、Java API中文在线文档：http://tool.oschina.net/apidocs/apidoc?api=jdk-zh、Java API中文网：http://www.matools.com/api/java8 等等。
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值