oboard-api

Get started developing...

# install deps
npm install

# run in development mode
npm run dev

# run tests
npm run test

There are two key files that enable you to customize and describe your API:

1. server/routes.js - This references the implementation of all of your routes. Add as many routes as you like and point each route your express handler functions.
2. server/common/api.yaml - This file contains your OpenAPI spec. Describe your API here. It's recommended that you to declare any and all validation logic in this YAML. express-no-stress-typescript uses express-openapi-validator to automatically handle all API validation based on what you've defined in the spec.

Install all package dependencies (one time operation)

npm install

Runs the application is development mode. Should not be used in production

npm run dev

or debug it

npm run dev:debug

Compiles the application and starts it in production production mode.

npm run compile
npm start

Run the Mocha unit tests

npm test

or debug them

npm run test:debug

• Open you're browser to http://localhost:3000
• Invoke the /examples endpoint

  curl http://localhost:3000/api/v1/examples

npm run dev:debug

npm run test:debug

Add these contents to your .vscode/launch.json file

View airbnb linter output

npm run lint

Fix all airbnb linter errors

npm run lint

Deploy to CloudFoundry

cf push onboard-api