Important: The API-first approach for building LoopBack applications is not yet fully supported. Therefore, some of the sections in this page are outdated and may not work out of the box. They will be revisited after our MVP release.
LoopBack 4 is more than just a framework: It’s an ecosystem that encourages developers to follow best practices through predefined standards. This section will walk through some important guidelines by building an example API for a catalog of products.
Our best practice follows an “API first” and test-driven development approach:
- Defining the API: There are two possible approaches to take in this
- Defining the API using code-first approach: This section guides you through setting up a skeleton of your application so that its full OpenAPI specification can be automatically generated.
- Defining the API using design-first approach:
This section guides you through constructing your API first before any
internal logic is added. Not fully supported
- Testing the API: This section describes the process of writing smoke test for your API and its spec. Not fully supported
- Defining your testing strategy: This section discusses the advantages and the process of building a strong testing suite.
- Implementing features: This section demonstrates how the tests for each feature of your application should be written, and how to write the logic to make these tests pass. In the example, the tests for the controller, model, repository, data source, and sequence are written and then implemented.
- Preparing the API for consumption: This section shows how the endpoints can be physically tested using the Swagger UI.