Giter Club home page Giter Club logo

api-document's Introduction

demo

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

api-document's People

Contributors

yalishizhude avatar

Watchers

walle avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.