How to Extend an Endpoint Validator

In this guide, you'll learn how to extend an endpoint validator from the Medusa core.

Overview

Request fields passed to endpoints that are defined in the Medusa core are validated to ensure that only expected fields are passed, and the passed fields are of correct types.

In some scenarios, you may need to allow passing custom fields into an existing endpoint. If a custom field is passed to an endpoint in the core, the endpoint returns an error in the response.

To allow passing custom fields into core endpoints, you must extend Validators. Validators are classes that are used by the core to validate the request parameters to an endpoint.

This guide explains how to extend a validator to allow passing custom fields to an endpoint. You'll be extending the validator of the admin API Create Product endpoint as an example.

---

Prerequisites

This guide assumes you already have a Medusa backend installed and configured. If not, you can check out the backend quickstart guide.

---

Step 1: Create File

You can add the code to extend the validator in any file under the srcCopy to Clipboard directory of your Medusa project, but it should be executed by src/api/index.tsCopy to Clipboard.

For example, you can add the code in an exported function defined in the file src/api/routes/admin/products/create-product.tsCopy to Clipboard, then import that file in src/api/index.tsCopy to Clipboard and execute the function.

For simplicity, this guide adds the code directly in src/api/index.tsCopy to Clipboard. Make sure to create it if it's not already created.

---

Step 2: Extend Validator

In the file you created, which in this case is src/api/index.tsCopy to Clipboard, add the following content to extend the validator:

src/api/index.ts

import { registerOverriddenValidators } from "@medusajs/medusa"
import {
   AdminPostProductsReq as MedusaAdminPostProductsReq,
} from "@medusajs/medusa/dist/api/routes/admin/products/create-product"
import { IsString } from "class-validator"

class AdminPostProductsReq extends MedusaAdminPostProductsReq {
   @IsString()
   custom_field: string
}

registerOverriddenValidators(AdminPostProductsReq)

Report Incorrect CodeCopy to Clipboard

In this code snippet you:

1. Import the registerOverriddenValidatorsCopy to Clipboard function from the @medusajs/medusaCopy to Clipboard package. This utility function allows you to extend validators in the core.
2. Import the AdminPostProductsReqCopy to Clipboard class from @medusajs/medusaCopy to Clipboard as MedusaAdminPostProductsReqCopy to Clipboard since this guide extends the Create Product endpoint validator. If you're extending a different validator, make sure to import it instead.
3. Create a class AdminPostProductsReqCopy to Clipboard that extends MedusaAdminPostProductsReqCopy to Clipboard and adds a new field custom_fieldCopy to Clipboard. Notice that the name of the class must be the same name of the validator defined in the core. custom_fieldCopy to Clipboard has the type stringCopy to Clipboard. You can change the type or name of the field, or add more fields.
4. Call registerOverriddenValidatorsCopy to Clipboard passing it the AdminPostProductsReqCopy to Clipboard class you created. This will override the validator defined in the core to include the new field custom_fieldCopy to Clipboard among the existing fields defined in the core.

Validators are defined in the same file as the endpoint. To find the validator you need to override, find the endpoint file under @medusajs/medusa/dist/api/routesCopy to Clipboard and import the validator in that file.

---

Step 3: Test it Out

To test out your extended validator, build and start your Medusa backend:

• npm
• Yarn
• pnpm

npm run build
npx @medusajs/medusa-cli develop

Report Incorrect CodeCopy to Clipboard

yarn build
npx @medusajs/medusa-cli develop

Report Incorrect CodeCopy to Clipboard

pnpm run build
npx @medusajs/medusa-cli develop

Report Incorrect CodeCopy to Clipboard

Then, send a request to the endpoint you extended passing it your custom fields. To test out the example in this guide, send an authenticated request to the Create Product endpoint and pass it the custom_fieldCopy to Clipboard body parameter. The request should execute with no errors.