Skip to content

Zero-configuration, read-only JSON API proxy in front of an Airtable base

License

Notifications You must be signed in to change notification settings

thesephist/hurricane

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hurricane

Zero-configuration, read-only JSON API in front of an Airtable base.

Usage

You can compile Hurricane into a single executable binary with

go build cmd/hurricane.go -o ./hurricane

Run Hurricane with ./hurricane. Hurricane takes no command line arguments, but reads a couple of configuration strings from the environment:

HURRICANE_BASE_ID   Airtable Base ID
HURRICANE_API_KEY   Airtable API KEY

(optional)
HURRICANE_PORT      The network port on which Hurricane should listen

API

For a given base and each table, Hurricane exposes a simple API:

/ (root path)

List all records in the table / default view as a JSON array.

/recXXXXXX

Retrieve a specific record as a JSON object.

/view/XXXXXX

Retrieve all records in a view as a JSON array.

Caching

Airtable's API is rate-limited per API key, so Hurricane by default will cache queries to the Airtable API for 60 seconds. You can tweak the Cache instance in the main file to change this.

About

Zero-configuration, read-only JSON API proxy in front of an Airtable base

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages