Simple API

Categories

Component ID

2910364

Component name

Simple API

Component type

module

Maintenance status

Development status

Component security advisory coverage

not-covered

Downloads

74

Component created

Component changed

Component body

This module provides a very basic API that is really just parsing/caching JSON files in the public files directory. It can be used for testing, for proxying data, or (as the name implies) to provide a very simple API.

By default, the module provides routes for:
* A list of items - /api/simple/{DIRECTORY}
* A specific item - /api/simple/{DIRECTORY}/{ITEM_ID}

The item information is simply populated by a series of JSON files in public://{DIRECTORY}.
Each JSON file should have the name {ITEM_ID}.json.

EXAMPLE - if you copy the "data" folder in the module to your public files directory, then the routes will be:
* /api/simple/data
* /api/simple/data/macbook_air_11
* /api/simple/data/macbook_air_13

This doesn't require the database, and only really operates at very low levels. While it should do fine for alot of things, its not intended to scale too big. Consider that the "list" route provides all of the item data in a single response.