中文文档

Your star would encourage me to improve this project insistently and I really appreciate it.

HTTP API document server

API document manage&http request test server.

Installation

1.Please make sure that you have installed mongodb
2.Node.js also needs to be installed
3.Install the project

$ git clone https://github.com/yalishizhude/api-document.git

4.Install bower

$ npm install bower

5.install modules

$ npm install
$ bower install

Features

• Support edit&view api document online.
• Support simple authority management.
• Provide a mock server responding data to front-end without database and back-end server(api-mockmust be installed).
• Send request to back-end and mark status of the interface development.
• Support JSON Schema validation to verify request/response params.

Quick Start

1.Start your mongodb
2.Install modules

$ npm install

3.Start the server

$ npm start

Notice

• Maybe you need to config the mongodb's params in routes/config.js if you changed mongodb's default connection.
• All delete operation are double left click.
• default user: admin/admin

Docs

mockjs (http://mockjs.com/)

mongodb (https://www.mongodb.org/)

express (http://expressjs.com/)

angular (http://docs.angularjs.cn/guide)

node (https://nodejs.org)

License

MIT