|
|
@@ -8,6 +8,8 @@
|
|
|
- 强调AGI在测试环节模拟数据和测试脚本的重要性
|
|
|
- 实验任务
|
|
|
- 根据需求完成会员邀请系统API设计、数据表设计、接口单元测试。
|
|
|
+- 示例项目
|
|
|
+ - GIT代码库 [飞码GTI仓库 搜索node-invite-system项目](http://git.fmode.cn:3000/futurestack/node-invite-system)
|
|
|
|
|
|
|
|
|
# 需求描述
|
|
|
@@ -624,4 +626,63 @@ node test.js
|
|
|
inviteDate: null
|
|
|
}
|
|
|
}
|
|
|
-```
|
|
|
+```
|
|
|
+
|
|
|
+# 技术文档
|
|
|
+## APIDOC配置和生成
|
|
|
+- 根据APIDOC，生成完整API文档
|
|
|
+
|
|
|
+> 提示词：我用apidoc描述了node/express项目，请问我该如何生成api文档？
|
|
|
+
|
|
|
+要生成API文档，您可以使用apidoc提供的命令行工具来生成静态HTML文档。以下是生成API文档的步骤：
|
|
|
+
|
|
|
+1. 首先，确保您已经在项目的根目录下安装了apidoc包。如果没有安装，您可以使用以下命令进行安装：
|
|
|
+
|
|
|
+```
|
|
|
+npm install apidoc --save-dev
|
|
|
+```
|
|
|
+
|
|
|
+2. 在您的项目中创建一个名为`apidoc.json`的配置文件，用于配置apidoc生成API文档的参数。您可以根据您的项目需求进行配置，以下是一个简单的示例：
|
|
|
+
|
|
|
+```json
|
|
|
+{
|
|
|
+ "name": "会员邀请注册API",
|
|
|
+ "version": "1.0.0",
|
|
|
+ "description": "记录会员邀请关系，查询会员邀请列表",
|
|
|
+ "title": "邀请注册API",
|
|
|
+ "url" : "http://localhost:3000",
|
|
|
+ "sampleUrl": "http://localhost:3000"
|
|
|
+ }
|
|
|
+```
|
|
|
+
|
|
|
+3. 在您的项目中编写好注释，并在您的代码中使用apidoc的注释格式来描述API接口。例如：
|
|
|
+
|
|
|
+```javascript
|
|
|
+/**
|
|
|
+ * @api {get} /user/:id Request User information
|
|
|
+ * @apiName GetUser
|
|
|
+ * @apiGroup User
|
|
|
+ *
|
|
|
+ * @apiParam {Number} id User's unique ID.
|
|
|
+ *
|
|
|
+ * @apiSuccess {String} name User's name.
|
|
|
+ * @apiSuccess {String} email User's email.
|
|
|
+ */
|
|
|
+```
|
|
|
+
|
|
|
+4. 运行以下命令来生成API文档：
|
|
|
+
|
|
|
+```
|
|
|
+npx apidoc -i ./ -o docs/
|
|
|
+```
|
|
|
+
|
|
|
+其中，`<input_dir>`是您存放API文档注释的目录，`<output_dir>`是生成的API文档的输出目录。
|
|
|
+
|
|
|
+5. 完成后，您会在指定的输出目录中看到生成的API文档。您可以通过浏览器打开`index.html`文件来查看您的API文档。
|
|
|
+
|
|
|
+希望这些步骤能帮助您成功生成API文档！如果您有任何其他问题，请随时告诉我。
|
|
|
+
|
|
|
+## APIDOC接口文档预览
|
|
|
+
|
|
|
+
|
|
|
+
|
LingYun