Giter Club home page Giter Club logo

mockrestapi's Introduction

Mock REST API

This project aims to build a barebones REST API, easily confugurable with a JSON schema. It is not intended to be used in production, rather is to be used to quicly bootstrap a REST API for initial development/testing.

Dependencies

Model Schema

The purpose of schema.json is to

  1. Configure the model for which the REST API will be created
  2. Configure the api routes and available methods.
  3. Seed the model with initial data.

A default schema.json is provided for reference and will be used if no schema is provided explicityly. To provide an external schema, pass the --schema /path/to/schema.json parameter. Will add the ability to upload and edit schema via GUI in the future.

schema.json config

  • Model name
  • Base URL for REST API
  • Methods: Allowed methods out of CRUD
  • Model fields format:
    • _id(optional)
    • type: {"string", "number", }
    • default value(optional)
  • Seed data

TODO

  • GUI to configure schema
  • Ability to view and interact with all of db data on GUI
  • Save and load DB data for persistence between launches
  • Error Handling
  • Automatic Tests
  • Authentication configuration (Token login, Include Auth token in header)
  • Better Documentation

mockrestapi's People

Contributors

alcatraz627 avatar

Stargazers

Roman avatar

Watchers

James Cloos avatar  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.