Skip to content
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.

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

docs: add examples for index.ts files on server routes #23390

Merged
merged 4 commits into from Sep 27, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/2.guide/2.directory-structure/1.server.md
Expand Up @@ -180,6 +180,38 @@ Given the example above, fetching `/test` with:
- **POST** method: Returns `Test post handler`
- Any other method: Returns 405 error

You can also use `index.[method].ts` inside a directory for structuring your code differently.

**Example:**

```ts [server/api/foo/index.ts]
export default defineEventHandler((event) => => {
DamianGlowala marked this conversation as resolved.
Show resolved Hide resolved
// handle the `api/foo` endpoint
})
```

This is useful to create API namespaces.

**Example:**

```ts [server/api/foo/index.get.ts]
export default defineEventHandler((event) => => {
// handle GET requests for the `api/foo` endpoint
})
```

```ts [server/api/foo/index.post.ts]
export default defineEventHandler((event) => => {
// handle POST requests for the `api/foo` endpoint
})
```

```ts [server/api/foo/bar.get.ts]
export default defineEventHandler((event) => => {
// handle GET requests for the `api/foo/bar` endpoint
})
```

### Catch-all Route

Catch-all routes are helpful for fallback route handling. For example, creating a file named `~/server/api/foo/[...].ts` will register a catch-all route for all requests that do not match any route handler, such as `/api/foo/bar/baz`.
Expand Down