https://github.com/heimdallrj/json-api-spec

A minimalistic specification for building RESTful APIs in JSON
https://github.com/heimdallrj/json-api-spec

api-spec documentation json json-api mock-server restful-api

Last synced: about 14 hours ago
JSON representation

A minimalistic specification for building RESTful APIs in JSON

• Host: GitHub
• URL: https://github.com/heimdallrj/json-api-spec
• Owner: heimdallrj
• Created: 2020-07-25T11:33:05.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-13T09:31:58.000Z (about 2 years ago)
• Last Synced: 2024-04-25T10:02:40.198Z (9 months ago)
• Topics: api-spec, documentation, json, json-api, mock-server, restful-api
• Language: JavaScript
• Homepage:
• Size: 132 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# json:api:spec

A minimalistic specification for building RESTful APIs in JSON.

This project inspired after [{json:api}](https://jsonapi.org/)

**{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](https://github.com/thinkholic/json-api-spec/blob/master/SPEC.md).

## MockServer

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

Check [README](https://github.com/thinkholic/json-api-spec/blob/master/mock-server/README.md) 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"

  }

}

```

[![CC0 1.0 Universal (CC0 1.0)

Public Domain Dedication](https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](https://creativecommons.org/publicdomain/zero/1.0/)