on GitHub" data-tooltip-id=":R1blcldtb:">v2.5·Edited Dec 4·
In this chapter, you’ll learn what API Routes are and how to create them.
An API Route is an endpoint. It exposes commerce features to external applications, such as storefronts, the admin dashboard, or third-party systems.
The Medusa core application provides a set of admin and store API routes out-of-the-box. You can also create custom API routes to expose your custom functionalities.
An API Route is created in a TypeScript or JavaScript file under the src/api
directory of your Medusa application. The file’s name must be route.ts
or route.js
.
Each file exports API Route handler functions for at least one HTTP method (GET
, POST
, DELETE
, etc…).
For example, to create a GET
API Route at /hello-world
, create the file src/api/hello-world/route.ts
with the following content:
To test the API route above, start the Medusa application:
Then, send a GET
request to the /hello-world
API Route: