Skip to content

Expand Example Documentation at "openapi-ts.dev/examples" #1813

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

Merged
merged 6 commits into from
Aug 14, 2024
Merged
Changes from 2 commits
Commits
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
81 changes: 81 additions & 0 deletions docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Fetching data can be done simply and safely using an **automatically-typed fetch

- [openapi-fetch](/openapi-fetch/) (recommended)
- [openapi-typescript-fetch](https://www.npmjs.com/package/openapi-typescript-fetch) by [@ajaishankar](https://github.com/ajaishankar)
- [feature-fetch](https://www.npmjs.com/package/feature-fetch) by [builder.group](https://github.com/builder-group)

::: tip

Expand Down Expand Up @@ -60,6 +61,86 @@ TypeChecking in server environments can be tricky, as you’re often querying da

:::

## Hono with `@blgc/openapi-router`

```ts [src/router.ts]
import { createHonoOpenApiRouter } from '@blgc/openapi-router';
import { Hono } from 'hono';
import { zValidator } from 'validation-adapters/zod';
import * as z from 'zod';

import { paths } from './gen/v1';
import { PetSchema } from './schemas';

export const router = new Hono();
export const openApiRouter = createHonoOpenApiRouter<paths>(router);

openApiRouter.get('/pet/{petId}', {
pathValidator: zValidator(
z.object({
petId: z.number()
})
),
handler: (c) => {
const { petId } = c.req.valid('param');

return c.json({
name: 'Falko',
photoUrls: []
});
}
});

openApiRouter.post('/pet', {
bodyValidator: zValidator(PetSchema),
handler: (c) => {
const { name, photoUrls } = c.req.valid('json');

return c.json({ name, photoUrls });
}
});
```

## Express with `@blgc/openapi-router`

```ts [src/router.ts]
import { createExpressOpenApiRouter } from '@blgc/openapi-router';
import { Router } from 'express';
import * as v from 'valibot';
import { vValidator } from 'validation-adapters/valibot';

import { type paths } from './gen/v1';
import { PetSchema } from './schemas';

export const router: Router = Router();
export const openApiRouter = createExpressOpenApiRouter<paths>(router);

openApiRouter.get('/pet/{petId}', {
pathValidator: vValidator(
v.object({
petId: v.number()
})
),
handler: (req, res) => {
const { petId } = req.params;

res.send({
name: 'Falko',
photoUrls: []
});
}
});

openApiRouter.post('/pet', {
bodyValidator: vValidator(PetSchema),
handler: (req, res) => {
const { name, photoUrls } = req.body;

res.send({ name, photoUrls });
}
});
```

## Mock-Service-Worker (MSW)

If you are using [Mock Service Worker (MSW)](https://mswjs.io) to define your API mocks, you can use a **small, automatically-typed wrapper** around MSW, which enables you to address conflicts in your API mocks easily when your OpenAPI specification changes. Ultimately, you can have the same level of confidence in your application's API client **and** API mocks.
Expand Down