Nodejs 如何指定 apidoc 的文档的访问路由?
Nodejs 如何指定 apidoc 的文档的访问路由?
比如我开一个 3000 端口的服务,一打开就是 apidoc 的文档。而我并想要这种情况,应该在哪里配置呢?
3 回复
顶一下
nginx
在 Node.js 项目中,如果你想指定 apidoc 文档的访问路由,通常需要使用一个 HTTP 服务器框架(如 Express.js)来托管这些文档。apidoc 本身是一个文档生成工具,它负责生成静态的 HTML 文件,而不是直接提供路由服务。以下是一个使用 Express.js 来托管 apidoc 文档的示例:
-
安装必要的依赖:
npm install express apidoc
-
生成 apidoc 文档: 在项目根目录下创建一个
apidoc.json
配置文件,并运行apidoc -i . -o doc/
来生成文档到doc/
目录。 -
创建 Express 应用并设置路由:
const express = require('express'); const path = require('path'); const app = express(); const PORT = 3000; // 托管 apidoc 生成的静态文件 app.use('/api-docs', express.static(path.join(__dirname, 'doc'))); app.listen(PORT, () => { console.log(`Server is running on http://localhost:${PORT}`); });
-
启动服务器: 在
package.json
中添加一个启动脚本,或者在命令行中运行node your_server_file.js
(假设你的服务器文件名为your_server_file.js
)。 -
访问 apidoc 文档: 打开浏览器,访问
http://localhost:3000/api-docs
,你应该能看到由 apidoc 生成的 API 文档。
通过这种方式,你可以灵活地指定 apidoc 文档的访问路由,并轻松集成到你的 Node.js 项目中。