Skip to content

Recommend fully qualified handler names in Routes documentation #2845

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 20, 2025
Merged

Recommend fully qualified handler names in Routes documentation #2845

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0008696
docs(backend): correct TypeScript code fences in TS tabs (controllers…
web-flow Nov 20, 2025
49a15fb
docs(bundlers): clarify webpack config example rename and JS/TS filen…
web-flow Nov 20, 2025
9502ba1
docs(routes): add guidance to prefer fully-qualified handler names in…
web-flow Nov 20, 2025
e7d055e
Limit PR scope based on title; keep only intended doc(s); revert unre…
web-flow Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docusaurus/docs/cms/backend-customization/routes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ module.exports = createCoreRouter('api::restaurant.restaurant', {

<TabItem value="ts" label="TypeScript">

```js title="./src/api/[apiName]/routes/[routerName].ts (e.g './src/api/restaurant/routes/restaurant.ts')"
```ts title="./src/api/[apiName]/routes/[routerName].ts (e.g './src/api/restaurant/routes/restaurant.ts')"

import { factories } from '@strapi/strapi';

Expand Down Expand Up @@ -149,7 +149,7 @@ module.exports = createCoreRouter('api::restaurant.restaurant', {

<TabItem value="ts" label="TypeScript">

```js title="./src/api/restaurant/routes/restaurant.ts"
```ts title="./src/api/restaurant/routes/restaurant.ts"

import { factories } from '@strapi/strapi';

Expand All @@ -168,7 +168,7 @@ export default factories.createCoreRouter('api::restaurant.restaurant', {
</TabItem>
</Tabs>

This only allows a `GET` request on the `/restaurants` path from the core `find` [controller](/cms/backend-customization/controllers) without authentication.
This only allows a `GET` request on the `/restaurants` path from the core `find` [controller](/cms/backend-customization/controllers) without authentication. When you reference custom controller actions in custom routers, prefer the fully‑qualified `api::<api-name>.<controllerName>.<actionName>` form for clarity (e.g., `api::restaurant.restaurant.review`).

### Creating custom routers

Expand Down