Jpom/docs/README.md
2022-03-08 11:39:31 +08:00

17 lines
446 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Jpom 服务端接口文档
## 参与开发
```
# 安装 apiDoc
npm install apidoc -g
# 生成 apiDoc 文档(需要在项目根目录执行)
apidoc -c docs/apidoc.json -i modules/server/src/ -o docs/apidoc/doc-2.8.13
```
> 开发文档https://apidocjs.com/
>
> 示例文档https://github.com/apidoc/apidoc/blob/master/example/_apidoc.js
>
> GitHub 仓库https://github.com/apidoc/apidoc
>
> [开发规范](../README_CONTRIBUTE.md)