💥 Deprecated and archived 💥

CCF Data API and Specification

A specificaton and set of web service calls to return information about CCF-mapped data

Specification

The original specification this API is based off of is available on Google Docs

Documentation

Auto-generated API Documentation is available on SmartAPI.

Development Requirements

• NodeJS v8.11+
• Docker

Initializing the development environment

After installing the prerequisites, simply run: npm ci or npm install to install all dependencies. Most of the necessary commands are embedded in the package.json file in the scripts section.

Some useful commands

Bundling the schema

npm run build

Validating the schema

npm run validate

Starting a mock server

npm start (or npm run start:mock)

This will create a mock OpenAPI server on port 8080 (Try http://localhost:8080/donors) and a GraphQL endpoint on port 8081 (Try http://localhost:8081/graphql).

Starting a mock server with Docker

docker-compose -f docker/docker-compose.mock-server.yml up or (npm run start:docker-mock)

This will create a mock OpenAPI server on port 8080 (Try http://localhost:8080/donors) and a GraphQL endpoint on port 8081 (Try http://localhost:8081/graphql).