yet-another-json-server 0.26.2

A REST API for JSON content with zero coding.

Yet Another JSON Server

Introduction

A REST API for JSON content with zero coding.

Technologies::

• Python 3.13+
• FastAPI 0.116+

The projects json-server and Python JSON Server inspires this one.

Getting started

This project has two options to have your data available for the API.

1. Create a JSON file with your resources data.
   So, use the docker image and define the file as volume for the API.
2. Upload a CSV file into the API which will converte it to a JSON file, and the file name is used as the resource name.
   For awhile, this option will updata the JSON file as a whole.

JSON file simple sample data structures:
(e.g.: my-db-data.json)

Case with one "resources" (posts).

{
    "posts": [
    {
      "id": 1,
      "title": "Yet Another JSON Server",
      "author": "Adriano Vieira"
    }
  ]
}

or

Multiple "resources" (`posts`, `comments`, `products`, and `stoke-exchange`). 👈🏽

{
  "posts": [ {"id": 1, "title": "Yet Another JSON Server", "author": "Adriano Vieira" } ],
  "comments": [ {"id": 1, "body": "some comment", "postId": 1 } ],
  "products": [
    {
      "productId": 375,
      "title": "Dress",
      "brand": "Adidas",
      "price": 40,
      "reviewScore": 1.0431592108,
      "color": "Black",
      "size": "XL",
      "image": "http://products.net/img/"
    }
  ],
  "stoke-exchange": [
    {
      "company": "Chuchu e Melão S/A",
      "city": "Belo Horizonte",
      "ceoUserId": "99273502-9448-4197-abc4-422d4c792264",
      "state": "Minas Gerais",
      "id": 17,
      "country": "Brasil",
      "postcode": 40256,
      "idProduct": 19,
      "priceTag": "45,593,820",
      "shareValue": "617.00"
    }
  ]
}

For those examples:

• the "resources": posts, comments, products, and stoke-exchange are the resources enpoints that you would make requests on the API.
• the "requests": posts/1, comments/1, products/375, and stoke-exchange/99273502-9448-4197-abc4-422d4c792264 will get a valid responses data.
  • But the requests: stoke-exchange/17 and stoke-exchange/19 will get error response
    (read the OpenAPI Document for details).

API operation

You can use it as Python module or containerized.

Module

Install the JSON server by:

pip install yet-another-json-server

After this, you can run:

ya-json-server

Setup:: via environment variables:

• APP_JSON_FILENAME: optional, defaults to data/db.json.
• APP_PORT: optional, defaults to 8000.

Container

You can use the docker image from the project, e.g.:

docker run --rm -it -p 80:8000 -v ./my-db-data.json:/home/worker/data/db.json \
  registry.gitlab.com/adrianovieira/ya-json-server:0.26.2

This way, you can access the documentation for the running API at http://api.localhost/docs, such as:

.Read it on link:docs/openapi.json[OpenAPI Document] description. [align="center"] image::docs/api.png[OpenAPI Document, 480]

Making requests

Check the link:docs/openapi.json[OpenAPI Document] to read the full description for each endpoint.

endpoints	summary
GET /	Get list of resources.
GET /{resource}	Get all the data of the resource.
GET /{resource}/{id}	Get the resource ID data.
PUT /upload	Update DB JSON file from CSV file content.
...

Check the OpenAPI Document to read the full description for each endpoint.

You also can access the documentation for the running API at http://api.localhost/docs

License

Apache License 2.0