Add a REST endpoint

REST-style endpoints can be defined as part of a plugin.

Info

REST endpoints are implemented as NestJS Controllers. For comprehensive documentation, see the NestJS controllers documentation.

In this guide we will define a plugin that adds a single REST endpoint at http://localhost:3000/products which returns a list of all products.

Create a controller

First let's define the controller:

src/plugins/rest-plugin/api/products.controller.ts

// products.controller.tsimport { Controller, Get } from '@nestjs/common';import { Ctx, ProductService, RequestContext } from '@vendure/core';@Controller('products')export class ProductsController {    constructor(private productService: ProductService) {    }    @Get()    findAll(@Ctx() ctx: RequestContext) {        return this.productService.findAll(ctx);    }}

The key points to note here are:

The @Controller() decorator defines the base path for all endpoints defined in this controller. In this case, all endpoints will be prefixed with /products.
The @Get() decorator defines a GET endpoint at the base path. The method name findAll is arbitrary.
The @Ctx() decorator injects the RequestContext which is required for all service methods.

Add a REST endpoint

Create a controller

Add a REST endpoint

Create a controller

Register the controller with the plugin

Controlling access to REST endpoints