Skip to content

adding-an-endpoint.md

Latest commit

 

History

History
38 lines (28 loc) · 1.73 KB

adding-an-endpoint.md

File metadata and controls

38 lines (28 loc) · 1.73 KB
Raw
title Adding an Endpoint
description How to contribute a new API dataset to the project
audience developer

Wiki Home › Endpoint Data

Adding an Endpoint

A new API is three files plus a registry rebuild. This is the most common contribution — see the pull request flow for process.

flowchart LR
    A["1 · Create<br/>server/api/name.json"] --> B["2 · Copy to<br/>name.json.backup"]
    B --> C["3 · Regenerate registry<br/>GET /generate"]
    C --> D["4 · Restart server<br/>(nodemon does this on file change)"]
    D --> E["Live at /name/:resource"]
Loading

Steps

  1. Create server/api/<name>.json following the endpoint JSON format — a metaData entry plus one array per resource, each record with a unique id.
  2. Copy it to server/api/<name>.json.backup — the pristine twin that resets restore from.
  3. Regenerate the API registry by hitting GET /generate on a running server. This rewrites server/GeneratedAPIList.js, which is checked in — commit it with your data files.
  4. The router mounts APIs from the registry at startup, so the server needs a restart to pick the new API up; locally nodemon restarts automatically when the file changes.

Verify

  • GET http://localhost:5555/<name>/<resource> returns your data
  • Your API appears on the site's API list (it reads /frontend)
  • GET /test shows your endpoints passing (see Testing)

Related