@risemaxi/api-client/readme.md

Client Library for Rise

# Rise API client

This package contains an api client for Risevest. The contract is generated from an OpenAPI file, and then a client is built around this contract.

It uses [typebox](https://github.com/sinclairzx81/typebox-codegen "typebox") to generate the contract from an OpenAPI file, and also `react-query`

## Installation

```shell
npm install @risemaxi/api-client --save
```

OR

```shell
yarn add @risemaxi/api-client
OR
```

```shell
bun install @risemaxi/api-client
```

## Usage

This lib also ships with a cli `rise-api`, so you can use it to generate the contract at will, just run:

```shell
bunx rise-api generate <input-file>
```

The input file can be a local file or a url pointing to a file.
For example

```shell
bunx rise-api generate ./swagger.yaml
```
## Example
```ts
import { createRiseApiClient, createRiseApiHooks } from '@risemaxi/api-client'

const apiClient = createRiseApiClient(async (method, url, params) => {
  const data = await fetch(url)
  const res = await data.json()
  return data
} , 'api.com' false)

const apiHooks = createRiseApiHooks(riseApi);
...

// Then later use the client like so:
apiClient.get('/plans', {
    query: {},
})
apiClient.post('/plans', {
    body: { id: "some-uuid" },
})

// Or use the hooks like so:
const { data } = apiHooks.useGet('/plans', {
    query: {},
})
```

## Parameters

| Name           | Type     | Default
|----------------|----------|---------
| `fetcher`      | Function |
| `baseUrl`      | String  <sup>Optional</sup> | ""
| `enableParsing`| Boolean <sup>Optional</sup> | true