Archived | Create REST APIs using LoopBack

Archived content

Archive date: 2020-08-24

This content is no longer being updated or maintained. The content is provided “as is.” Given the rapid evolution of technology, some content, steps, or illustrations may have changed.


Creating REST APIs has always been a challenging job. LoopBack, a highly extensible open source Node.js API framework, is meant to make that experience easy. IBM API Connect provides the tools to use with LoopBack projects. In this developer pattern, we’ll demonstrate the basic flows to create and expose REST APIs using LoopBack.


Assuming you want to create REST APIs for your web service, which tool first comes to mind? The answer may vary, but I can assure you that none will be as straightforward as LoopBack, especially if you are using JavaScript and Node.js. If you haven’t tried it out, now’s a good time to get started!

In this journey, we’ll build REST APIs for a service named AnimalsDemo. The service itself is fictional, but the steps are the same that you’d use for any real service. First, we create the APIs, which we then link to a data source. Second, we define the data models and set up access control. Finally, we push the app to IBM Cloud. These steps will remain the same even with an actual production-ready service. The beauty of LoopBack is it saves a lot of effort in coding redundant functionalities, since most REST APIs are about CRUD operations after all.



  1. User scaffolds API using LoopBack CLI.
  2. User links to Compose for MongoDB data source.
  3. User generates the model objects.
  4. User configures the ACL.
  5. User prepares the manifests for deployment.
  6. User pushes app to IBM Cloud® Cloud Foundry.