apidoc:用它为api编写doc

时间:2021-06-19 15:58:09
【文件属性】:
文件名称:apidoc:用它为api编写doc
文件大小:464KB
文件格式:ZIP
更新时间:2021-06-19 15:58:09
JavaScript 文档工具 apidoc的功能是记录项目开发和维护过程中不同部分之间的协作信息,包括接口信息、状态码信息已经其他备注信息。 功能部分 认证部分,能够实现用户的登录、注册,每个项目文档都能单独对用户的读写权限进行管理。 接口部分,实现HTTP协议的编写,TCP、UDP基础上的自定义协议编写,并能够实现接口信息的版本追溯。编写时能够支持Markdown语法,同时每个接口能够编写单独的测试脚本,用于接口的自动化测试,并通过一定的方式自动报告测试结果。 管理部分,每个项目能够指定或者更新管理员账号,管理员负责管理每个项目中的权限分配。 其他部分,能够*地编写其他文档。 实现方式 主体构成 NodeJS + Express + Mysql + redis session实现: redis-sessions 初始化方式 node /tasks/init.js 详细介绍 系统最*权限的用户就是系统管理
【文件预览】:
apidoc-master
----models()
--------user.js(381B)
--------document.js(740B)
--------index.js(780B)
--------privilege.js(612B)
--------project.js(468B)
--------class.js(373B)
----bin()
--------www(264B)
----config()
--------settings.js(864B)
--------environment.js(1KB)
----package.json(995B)
----tasks()
--------apidoc.sql(6KB)
--------init.js(194B)
----DESIGN.md(460B)
----routes()
--------document.js(290B)
--------index.js(507B)
--------account.js(383B)
--------api()
--------home.js(187B)
----middleware()
--------database.js(273B)
--------privilege.js(3KB)
----api()
--------document.js(2KB)
--------project.js(3KB)
----LICENSE(1KB)
----controllers()
--------document.js(734B)
--------account.js(2KB)
--------home.js(1KB)
----views()
--------document()
--------account()
--------common()
--------home()
--------public()
----common()
--------tools.js(13B)
----doc()
--------abbreviation.md(21B)
----.gitignore(39B)
----Notice.md(144B)
----service()
--------auth.js(2KB)
----public()
--------images()
--------less()
--------fonts()
--------js()
----app.js(905B)
----README.md(1KB)
----bower.json(472B)

网友评论