dm-shared-api

APi

The dm-shared-api is meant to be a sharable package to facilitate communication between microservices at DevMountain.

There are 2-3 points used in any shared-api:

• The service - This is the endpoint that will be fullfilling the request
• The middleman - This is the endpoint that will call our service from another server.
• [Optional] the UI - Where appropriate a directive is made that knows how to invoke the middelman and inject functionality.

TheService

In the first use case we have two microservices that want to interact : class and surveys. class wants to be able to call surveys and embedd a directive to manage/invite students to take surveys.

In this use case surveys is our service because it will be fullfilling the end request.

class is going to be our middleman. The server on class will need an endpoint that can hit the service on surveys.

surveysDirective is our UI. It knows how to hit our middleman which then hits our service.

Usage

The service

If you want to fullfill an api request install this module then get your Routes construct.

var Routes = require('.').Routes;

Initialize a new route passing in your express app :

var routes = new Routes(app);

Invoke the desired route you wish to fullfill. This will add an endpoint to your express app for you ensuring each of the endpoints match to the rest of the app.

routes.Surveys.untakenSurveysByUsers(app);

The middle man

If you want to be a middleman and consume another service then follow the same steps as above for the service. For the last of the 3 steps look for an identically named function with then name Middleman appended. IE -

routes.Surveys.untakenSurveysByUsers(app);

->

routes.Surveys.untakenSurveysByUsersMiddleman(app);

UI

surveys Directive

Add a script reference to the surveysDirective.js file found in node_modules/dm-shared-api/lib/surveysDirective/surveysDirective.js to your product

Add dmSurveys as a dependency to your app

Required Middlemen

routes.Surveys.untakenSurveysByUsersMiddleman(app);

Adding new endpoints

Building

Only the the typesript files in the /src directory are compiled by webpack.
The rest are managed by the tsconfig.json file that can be passed into any typescript compiler.

Directive

The surveysDirective needs to be compiled with the webpack.config located in /src/surveysDirective

Testing

The directive can be tested by running the server.js file located in /lib with nodemon The navigate to /lib/test/surveysDirective/index.html

The service

The serivce is the actual endpoint that will be fullfilling the request. Most of our endpoints throughout our microservices are utilized only once by the product/service itself. But when an endpoint will be used more than once or needs to be used externally it should be included in this shared-api library.

• Add an entry into the Routes.ts file located here.