ApiDoc的使用

最新推荐文章于 2024-09-26 18:24:36 发布

weixin_34390105

最新推荐文章于 2024-09-26 18:24:36 发布

阅读量117

点赞数

CC 4.0 BY-SA版权

文章标签： json

原文链接：https://juejin.im/post/5ac252795188255c56689c7f

本文介绍如何使用apidoc工具从源代码中自动生成接口文档。包括安装配置、添加接口文档注释、生成及查看文档等步骤。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

说明

apiDoc creates a documentation from API annotations in your source code
复制代码

apiDoc是一个接口文档，它的创建方式是基于你的源代码的接口备注。我们只需要给接口写好相应的文档，然后使用apiDoc生成接口文档工具生成文档，便于管理和查看。

配置方式

1.安装apidoc（npm是啥？？？自己问前端同学吧。。）

npm install apidoc -g
复制代码

安装http-server

npm install http-server -g 
复制代码

2.给接口添加文档（官方示例），添加在Controller入口方法前面。

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */
复制代码

3.创建apidoc.json(官方示例)

{
  "name": "example",
  "version": "0.1.0",
  "description": "apiDoc basic example",
  "apidoc": {
    "title": "Custom apiDoc browser title",
    "url" : "https://api.github.com/v1"
  }
}
复制代码

4.生成apiDoc

apidoc -i app/Http/Controllers -o apidoc/
复制代码

5.运行

http-server api/doc
复制代码

补充备注

参考

apidocjs.com/

转载于:https://juejin.im/post/5ac252795188255c56689c7f