2022-03-08 05:38:55 +08:00
|
|
|
|
# Jpom 服务端接口文档
|
2022-02-28 19:18:57 +08:00
|
|
|
|
|
2022-03-08 05:38:55 +08:00
|
|
|
|
## 参与开发
|
2022-02-28 18:54:36 +08:00
|
|
|
|
```
|
2022-03-08 05:38:55 +08:00
|
|
|
|
# 安装 apiDoc
|
|
|
|
|
|
npm install apidoc -g
|
|
|
|
|
|
# 生成 apiDoc 文档（需要在项目根目录执行）
|
2022-03-01 10:33:19 +08:00
|
|
|
|
apidoc -c docs/apidoc.json -i modules/server/src/ -o docs/apidoc/doc-2.8.13
|
2022-03-08 05:38:55 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
> 开发文档：https://apidocjs.com/
|
|
|
|
|
|
>
|
|
|
|
|
|
> 示例文档：https://github.com/apidoc/apidoc/blob/master/example/_apidoc.js
|
|
|
|
|
|
>
|
|
|
|
|
|
> GitHub 仓库：https://github.com/apidoc/apidoc
|
|
|
|
|
|
>
|
|
|
|
|
|
> [开发规范](../README_CONTRIBUTE.md)
|
