Astro lets you create custom endpoints to serve any kind of data. You can use this to generate images, expose an RSS document, or use them as API Routes to build a full API for your site.
In statically-generated sites, your custom endpoints are called at build time to produce static files. If you opt in to SSR mode, custom endpoints turn into live server endpoints that are called on request. Static and SSR endpoints are defined similarly, but SSR endpoints support additional features.
Static File EndpointsSection titled Static File Endpoints
To create a custom endpoint, add a
.ts file to the
/pages directory. The
.ts extension will be removed during the build process, so the name of the file should include the extension of the data you want to create. For example,
src/pages/data.json.ts will build a
Endpoints export a
GET function (optionally
async) that receives a context object with properties similar to the
Astro global. Here, it returns a Response object with a
url, and Astro will call this at build time and use the contents of the body to generate the file.
Since Astro v3.0, the returned
Response object doesn’t have to include the
encoding property anymore. For example, to produce a binary png image:
You can also type your endpoint functions using the
Section titled params and Dynamic routing
params and Dynamic routing
Endpoints support the same dynamic routing features that pages do. Name your file with a bracketed parameter name and export a
getStaticPaths() function. Then, you can access the parameter using the
params property passed to the endpoint function:
This will generate four JSON endpoints at build time:
/api/3.json. Dynamic routing with endpoints works the same as it does with pages, but because the endpoint is a function and not a component, props aren’t supported.
Section titled request
All endpoints receive a
request property, but in static mode, you only have access to
request.url. This returns the full URL of the current endpoint and works the same as Astro.request.url does for pages.
Server Endpoints (API Routes)Section titled Server Endpoints (API Routes)
Everything described in the static file endpoints section can also be used in SSR mode: files can export a
GET function which receives a context object with properties similar to the
But, unlike in
static mode, when you configure
server mode, the endpoints will be built when they are requested. This unlocks new features that are unavailable at build time, and allows you to build API routes that listen for requests and securely execute code on the server at runtime.
Be sure to enable SSR before trying these examples.
Server endpoints can access
params without exporting
getStaticPaths, and they can return a
Response object, allowing you to set status codes and headers:
This will respond to any request that matches the dynamic route. For example, if we navigate to
params.id will be set to
helmet exists in the mock product database, the endpoint will use create a
Response object to respond with JSON and return a successful HTTP status code. If not, it will use a
Response object to respond with a
In SSR mode, certain providers require the
Content-Type header to return an image. In this case, use a
Response object to specify a
headers property. For example, to produce a binary
HTTP methodsSection titled HTTP methods
In addition to the
GET function, you can export a function with the name of any HTTP method. When a request comes in, Astro will check the method and call the corresponding function.
You can also export an
ALL function to match any method that doesn’t have a corresponding exported function. If there is a request with no matching method, it will redirect to your site’s 404 page.
Section titled request
In SSR mode, the
request property returns a fully usable
Request object that refers to the current request. This allows you to accept data and check headers:
RedirectsSection titled Redirects
The endpoint context exports a
redirect() utility similar to