json-api-server-example's Introduction

json-api-server-example

An example JSON API server using Postgres and Express

Created to help me learn the JSON API format. It uses the MassiveJS library to access a Postgres database.

Installation

npm install

Usage

You'll need Postgres to be installed and running. You can then setup the database:

npm run setup-database

Start the server:

npm start

This will start a server running at http://127.0.0.1:3000.

Features

The API implements the basic CRUD actions for a single collection:

GET /people
POST /people
GET /people/:id
PATCH /people/:id
DELETE /people/:id

Sorting

The GET /people route supports sorting as described in the sorting specification. Multiple sort fields can be used together:

GET /people?sort=surname,-name HTTP/1.1

Pagination

Page-based pagination is implemented as per the pagination specification:

GET /people?page[number]=2&page[size]=1 HTTP/1.1

Filtering

The filter parameter can be used to filter records as described in the recommendations for filtering:

GET /people?filter[name]=Ron&filter[surname]=Weasley HTTP/1.1

json-api-server-example's People

Contributors

Watchers

json-api-server-example's Issues

Implement strict content negotiation

See: http://jsonapi.org/format/#content-negotiation-servers.

Servers MUST respond with a 415 Unsupported Media Type status code if a request specifies the header Content-Type: application/vnd.api+json with any media type parameters.

Servers MUST respond with a 406 Not Acceptable status code if a request's Accept header contains the JSON API media type and all instances of that media type are modified with media type parameters.

Recommend Projects