swr-openapi
Generate swr hooks using OpenAPI schemas
## Setup
```sh
npm install swr-openapi swr openapi-fetch
```
Follow [openapi-typescript](https://openapi-ts.dev/) directions to generate TypeScript definitions for each service being used.
Here is an example of types being generated for a service via the command line:
```sh
npx openapi-typescript "https://sandwiches.example/openapi/json" --output ./types/sandwich-schema.ts
```
## Basic Usage
Initialize an [openapi-fetch](https://openapi-ts.dev/openapi-fetch/) client and create any desired hooks.
```ts
// sandwich-api.ts
import createClient from "openapi-fetch";
import { createQueryHook } from "swr-openapi";
import type { paths as SandwichPaths } from "./types/sandwich-schema";
const client = createClient(/* ... */);
const useSandwiches = createQueryHook(client, "sandwich-api");
const { data, error, isLoading, isValidating, mutate } = useSandwiches(
"/sandwich/{id}", // <- Fully typed paths!
{
params: {
path: {
id: "123", // <- Fully typed params!
},
},
},
);
```
## 📓 Docs
[View Docs](https://openapi-ts.dev/swr-openapi)