Vendure电商平台开发指南：如何添加自定义REST端点-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00207/article/details/148487724

Vendure电商平台开发指南：如何添加自定义REST端点

vendure A headless GraphQL commerce platform for the modern web 项目地址: https://gitcode.com/gh_mirrors/ve/vendure

前言

在Vendure电商平台开发过程中，我们经常需要扩展系统功能，添加自定义的API端点。本文将详细介绍如何在Vendure中创建REST风格的端点，这是开发者扩展平台功能的重要技能。

REST端点基础概念

REST端点本质上是遵循REST架构风格的API接口，它使用HTTP方法(GET、POST等)来执行操作。在Vendure中，这些端点是通过NestJS控制器实现的。

创建控制器

让我们从一个简单的产品控制器开始，它提供一个获取所有产品的端点：

// products.controller.ts
import { 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);
    }
}

代码解析

@Controller('products') 装饰器定义了控制器的基本路径，所有端点都将以/products开头
@Get() 装饰器定义了一个GET方法端点
@Ctx() 注入了请求上下文(RequestContext)，这是调用Vendure服务方法的必需参数
通过构造函数注入ProductService，使我们能够调用产品相关服务

将控制器注册为插件

创建好控制器后，我们需要将其注册为一个Vendure插件：

import { PluginCommonModule, VendurePlugin } from '@vendure/core';
import { ProductsController } from './api/products.controller';

@VendurePlugin({
  imports: [PluginCommonModule],
  controllers: [ProductsController],
})
export class RestPlugin {}

关键点说明

PluginCommonModule 必须导入，它提供了对Vendure核心服务的访问权限
controllers 数组用于注册我们的控制器
这个插件可以像其他Vendure插件一样添加到系统配置中

配置插件

将创建好的插件添加到Vendure配置中：

import { VendureConfig } from '@vendure/core';
import { RestPlugin } from './plugins/rest-plugin/rest.plugin';

export const config: VendureConfig = {
    // 其他配置...
    plugins: [
        // 其他插件...
        RestPlugin,
    ],
};

端点权限控制

在实际应用中，我们通常需要对API端点进行权限控制：

import { Controller, Get } from '@nestjs/common';
import { Allow, Permission, Ctx, ProductService, RequestContext } from '@vendure/core';

@Controller('products')
export class ProductsController {
    constructor(private productService: ProductService) {}

    @Allow(Permission.ReadProduct)
    @Get()
    findAll(@Ctx() ctx: RequestContext) {
        return this.productService.findAll(ctx);
    }
}