A specificaton and set of web service calls to return information about CCF-mapped data
The original specification this API is based off of is available on Google Docs
Auto-generated API Documentation is available on SmartAPI.
- NodeJS v8.11+
- Docker
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.
npm run build
npm run validate
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).
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).