oag-react 0.1.0

React/SWR client generator for oag
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

# oag-react

React/SWR hooks generator for OpenAPI 3.x specs.

Extends the TypeScript generator with React-specific code: SWR hooks for data fetching and a context provider for the API client.

## Generated files

Everything from [`oag-typescript`](../oag-typescript/) plus:

| File | Description |
|------|-------------|
| `hooks.ts` | Typed React hooks for every operation |
| `provider.ts` | `ApiProvider` context component and `useApiClient()` hook |
| `index.ts` | Enhanced barrel exports (includes hooks and provider) |

## Hook types

| HTTP method | Hook pattern | Library |
|-------------|-------------|---------|
| `GET` | `useSWR` query hook | [SWR](https://swr.vercel.app/) |
| `POST`, `PUT`, `DELETE`, `PATCH` | `useSWRMutation` mutation hook | [SWR](https://swr.vercel.app/) |
| SSE streaming | Custom hook with `useState` + `useCallback` | React |

## Usage pattern

```tsx
import { ApiProvider, useListPets } from "./generated";

function App() {
  return (
    <ApiProvider baseUrl="https://api.example.com">
      <PetList />
    </ApiProvider>
  );
}

function PetList() {
  const { data, error, isLoading } = useListPets();
  // ...
}
```

## Depends on

- [`oag-core`](../oag-core/) — parser, IR, and `CodeGenerator` trait
- [`oag-typescript`](../oag-typescript/) — base TypeScript generation (React generator calls it internally)

## Part of [oag](../../README.md)