voorhoede / voorhoede-colibri-api

A RESTful and a GraphQL API exposing Voorhoede website content.

Voorhoede Colibri API

A RESTful and a GraphQL API exposing Voorhoede website content.

The API is backed by a DatoCMS instance where content is managed.

The API and its documentation is available on voorhoede-colibri-api.now.sh. Note that because it runs on the free tier of Now, it needs to spin up if it isn’t used for a while — which makes it slow the first time ’round 😴.

Development

Getting started

• Clone the repository.
• Copy .env.example to .env. You can find the DATA_API_TOKEN in the CMS settings > API Tokens. The CMS can be accessed using the [email protected] account (details in LastPass).
• Run npm install. Then use any of the pre-configured scripts.

Scripts

This project requires Node.js (>= v8) and npm (comes with Node).

After installing dependencies using npm install the following scripts are available:

npm run ...	Description
data	Downloads all data from CMS to the file system.
deploy	Deploys application to now and aliases latest deploy to voorhoede-colibri-api.now.sh.
dev	Starts local server with auto restart on file change on http://localhost:2473.
start	Starts local server in production mode on http://localhost:2473.
test	Run automated endpoint tests.
watch	Run tests on file changes.

License

MIT licensed © De Voorhoede

voorhoede-colibri-api's Issues

Add syntax highlighting to info page

Medium style?

Link to code on GitHub

Remove private model fields from data

in dato.config.js

Convert all markdown fields to HTML

configure in dato.config.js

Fix layout issues on smaller screens

• header / nav
• <code>
• side-by-side buttons on info page
• details on REST page

Generic models for all schema definitions/types

Blog, Contact, Event, Home, Job, Service, Work

Add proper license

Add info to schema definitions/types

Description, example values, defaults (?)
Share between REST and GraphQL schema (so part of models?)

Add app-header to GraphiQL layout

Add git repo info to package.json

Version and cache static assets

Add test coverage for all endpoints

See test setup

Deploy changes to master to Now using Travis CI

Use now-travis?

Add intro to info page

Add image to project readme

Add precommit hook to run tests?

Run automated tests on Travis CI

Describe deployment procedure in readme

Add support for sorting

• Sorting pattern REST: ?sort=title:asc,key2:desc
• Sorting pattern GraphQL: orderBy: title_ASC

Add document links to REST responses

Move repo to voorhoede

• Update link to GitHub

Add slugs of in other locales to data models

Use withLocale

REST parameter validation (against OpenAPI Schema)

• language
• fields
• limit
• offset

Add proper 404 responses for missing items

Add example use code & output to info page

Fix doc url for routes with /:slug

Example of incorrect URL: https://voorhoede-colibri-api-vblppzwyfw.now.sh/api/v1/posts/every-project-a-progressive-web-app?fields=titles