Version: 6.5.x

Create a Node.js Microservice Tutorial

In this tutorial we'll see how to create and expose a Node.js Microservice using Node.js template from the Marketplace.

What We’ll Build#

In this tutorial we'll develop a simply Node.js microservice that expose a route through the Mia-Platform API Gateway.

In particular calling the route we'll get a response in base of the value of an environment variable. In this example we'll creating a CRUD for storing customers and orders with a set of orders and develop a Microservice that calculate the shipping cost for a specific order. If the order belong to a new customer the shipping it's free, otherwise it's calculate from a fixed value.


We’ll assume that you have some familiarity with JavaScript and Node.js, but you can follow along even if you're coming from a different programming language. All concepts explained following are valid for all languages and frameworks.

Prepare your favourite IDE to interact with Git repositories.

Create CRUDs#

First of all open your project, and create the following MongoDB CRUD collections. In order to do this follow these steps:

Customers CRUD#

  1. In the Console select your project.
  2. Select Design section.
  3. Select the branch master.
  4. Go to section MongoDB CRUD and click Create new CRUD.
  5. Insert the name customers and press Create.
  6. Now you have to set your collection's fields. Scroll to Fields section and click Add New to create the following fields:

You can accelerate the field creation process importing them from JSON. In order to do this download orders crud JSON and customers crud JSON.

Field nameType
name (required)String
lastname (required)String

Orders CRUD#

Create orders CRUD with the following fields:

Field nameType
date (required)Date
orderItemsArray of Objects

Checkout CRUD Section or see this short video to learn how create CRUDs

CRUD in console

Now you should expose your collection through an Endpoint and create your first API.

  1. Go to section Endpoints and click Create new endpoint. Then enter the following information:

    • /customers as Base path.
    • CRUD as Type.
    • Select customers as CRUD.
  2. Click Create. You have just created your first API! The detail view shows other configurations that we'll use later. Scroll down to Routes section to see an overview of routes of your API.

  3. Create a new endpoint with the following information:

    • /orders as Base path.
    • CRUD as Type.
    • Select orders as CRUD.

CRUD in console

  1. To confirm changes just press Commit & Generate. We suggest to write a proper title for each commit, in this case, we can enter Created CRUDs "customer","orders" and the related endpoints.

All items in design area are not saved until you click Commit & Generate. However, you can create different entities and then save all the work only at the end.
Internally, when you commit, the Console properly updates and commit the Kubernetes files on configuration repository of your project.


Checkout the endpoint documentation for more information about the section and to discover all the potentialities of this feature.

Create the Microservice from the Marketplace Template#


Watch this short video to learn how it's easy to create a Node.js Microservice from templates

A Microservice can be created starting from existing Templates. Starting from a Mia-Platform Template or using Mia-Platform Service Libraries has many advantages and allows your microservice to be compliant with all best practices(such as testing, logging, health routes, etc).

In the Marketplace you can find a list of Examples or Templates powered and supported by Mia-Platform that allows you to set-up microservices with a tested and pre-defined function.

We'll create a microservice from Node.js template:

  1. Go to section Microservices section and click Create a Microservice.
  2. Search the template Node.js Template, then click the related tab.
  3. Now enter the following information:
    • get-shipping-cost as Name.
    • Select the suggested option as Docker Image Name.
  4. Commit the changes

The code base#


Health routes#

API Documentation#

Let's coding! Expose a route#

Envoironment variable#

Call the other services on the Platform project: read data from CRUDs#

Write tests#

Try the Microservice#