json:api:spec

A minimalistic specification for building RESTful APIs in JSON.

This project inspired after {json:api}

{json:api} is one of the best API specifications we have around. The intention of this project isn't competing but proposing more of a minimalistic, but scalable API specification which can apply to build RESTful APIs.

SPEC

This project is still in early stage. The idea is documenting every aspect of building RESTful APIs in the manner of minimalistic and scalable to fit for any kind of need.

Suggestions, comments are highly appreciated.

Check the SPEC.

MockServer

Get up and running a MockAPIServer (based on proposed specification) with zero coding.

Check README for detailed explaination.

---

Here's an example JSON Response:

GET /articles HTTP/1.1
Content-Type: application/json
Accept: application/json
X-Request-ID: ?

{
  "data": [
    {
      "id": "1",
      "title": "Hello World!",
      "summary": "Neque porro quisquam est qui dolorem",
      "body": "Neque porro **quisquam** est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit",
      "images": [
        {
          "url": "https://cdn.example.com/hello.png",
          "alt": "Hello!"
        }
      ],
      "timestamp": "Sat, 25 Jul 2020 13:24:57 GMT",
      "authors": {
        "data": [
          {
            "id": "11",
            "first_name": "John",
            "last_name": "Doe",
            "endpoints": {
              "extends": "/authors/11"
            }
          }
        ],
        "endpoints": {
          "explicit": "/articles/1/authors/"
        }
      },
      "comments": {
        "data": [
          {
            "id": "12",
            "body": "Nice writeup!",
            "author": {
              "id": "121",
              "name": "Jane Doe",
              "avatar": "https://cdn.example.com/users/jane-doe.png",
              "endpoints": {
                "extends": "/users/121"
              }
            },
            "endpoints": {
              "extends": "/comments/12"
            }
          }
        ],
        "endpoints": {
          "explicit": "/articles/1/comments/"
        }
      },
      "endpoints": {
        "explicit": "/articles/1"
      }
    }
  ],
  "endpoints": {
    "self": "/articles",
    "next": "/articles?limit=20&offset=21"
  }
}