sideroad / express-restful-api Goto Github PK

When HTTP request have x-json-schema, return JSON schema

?fields=name,age

should be response only two fields instead of every data

?expand=group,members

Add latlng to attribute type. format is latitude,longitude.

Be able to fetch collection filtered by latitude,longitude,radius(m).
Here is a example to search Kyoto around 1km.
location=35.5783703,136.6170494,1000

if seeds does not have parent as fruits and fruits have seeds as children.
It should be able to POST seeds as children such as below.

POST /fruits/grape/seeds/a
Push specified ID of seed into grape children

DELETE /fruits/grape/seeds
delete grape children

DELETE /fruits/grape/seeds/a
delete specified id from grape children

Add groupBy request parameter in collection fetch.
If there is number attribution type, calculate sum and response the amount as field.
Add size in grouped item.

Here is a example fetched collection without groupBy

{
  "items": [
    {
      "id": "29d3d12",
      "name": "sideroad",
      "amount": "1000"
    },
    {
      "id": "029234a",
      "name": "sideroad",
      "amount": "500"
    },
    {
      "id": "8eb23da",
      "name": "foobar",
      "amount": "100"
    }
  ]
}

Here is a example fetched collection with groupBy=name

{
  "items": [
    {
      "name": "sideroad",
      "amount": 1500,
      "size": 2
    },
    {
      "name": "foobar",
      "amount": 100,
      "size": 1
    }
  ]
}

Use PATCH method for NOT idempotent update.

URL
PATCH /apis/fruits/apple

Request Body
{ amount: 10 }

wildcard
name=*road

range search
createdAt=[2015-12-01,2015-12-05]

https://github.com/expressjs/multer

{ href: '/companies/aaa', id: 'aaa' }

options

{
  "person": {
    "name": {
      "regexp": "^[a-zA-Z 0-9]+$",
      "invalid": "Only alphabets number spaces allowed"
    },
    "age": {
      "regexp": "^[0-9]+$",
      "invalid": "Only number allowed"
    }
  }
}

/validation/groups?name=invalid_value&age=unknown

• HTTP Method ( GET )
• Status Code ( 400 or 200 )

Valid

No Response

Invalid

{
  "name": "Only alphabets number spaces allowed",
  "age": "Only number allowed"
}

/person/sideroad

client should be specify id to create or update instance.

PUT should be act as idempotent.

PUT for update should be replace all attribution for the data.

orderBy=age:desc,name:asc

To be able to specify with JSON schema

http://json-schema.org/example1.html

separate configuration singleton and collections

singleton only has READ and UPDATE.
singleton does not have CREATE and DELETE.

singleton be able to have a attribute of children, instance
singleton can not have a attribute of parent

fields=name,age