Mockapie is a simple Node.js module that serves static content from a directory and pretends to be a database-connected REST server.
If an HTTP request is made to /api/*
the REST+JSON server will be
activated. The request will be handled by fetching/manipulating data
in YAML files located in the data
directory.
Example URLs and how they map to YAML files:
-
GET /api/artists
: Return all records fromdata/artists.yml
-
POST /api/artists
: Add a new record todata/artists.yml
-
GET /api/artists/1
: Fetch a record fromdata/artists.yml
where theid
attribute is1
-
GET /api/artists/1/albums
: Fetch a record fromdata/albums.yml
where theartist_id
attribute is1
-
And so forth for all of the REST-related HTTP methods and arbitrary nesting of resources
When a request does not start with /api/*
then the static file
server will be used to serve files out of www
.
The server uses socket.io to push log messages to all connected sockets.
The following values are currently hard coded:
- Port: 3000
- YAML directory:
data
- Static file directory:
www
- REST+JSON URL prefix:
/api/
- AngularJS Course source code.