Example API Client

TypeScript/JavaScript client library for Example API, generated from OpenAPI specification.

Installation

npm install @yaoyaoyu/og-example-api-client

Usage

Basic Usage

import { createApiClient } from '@yaoyaoyu/og-example-api-client';

// 创建客户端实例
const client = createApiClient({
  basePath: 'https://api.example.com/v1'
});

// 使用 API
async function getUsers() {
  try {
    const response = await client.users.getUsers();
    console.log(response.data);
  } catch (error) {
    console.error('Error fetching users:', error);
  }
}

Using Custom Axios Instance

import axios from 'axios';
import { createApiClient } from '@yaoyaoyu/og-example-api-client';

// 创建自定义 axios 实例
const axiosInstance = axios.create({
  timeout: 10000,
  headers: {
    'Custom-Header': 'value'
  }
});

// 添加请求拦截器
axiosInstance.interceptors.request.use((config) => {
  // 添加认证 token
  config.headers.Authorization = `Bearer ${getAuthToken()}`;
  return config;
});

// 添加响应拦截器
axiosInstance.interceptors.response.use(
  (response) => response,
  (error) => {
    // 处理错误
    console.error('API Error:', error);
    return Promise.reject(error);
  }
);

// 使用自定义 axios 实例创建客户端
const client = createApiClient({
  basePath: 'https://api.example.com/v1',
  axiosInstance
});

Authentication

// API Key 认证
const client = createApiClient({
  basePath: 'https://api.example.com/v1',
  apiKey: 'your-api-key'
});

// Bearer Token 认证
const client = createApiClient({
  basePath: 'https://api.example.com/v1',
  accessToken: 'your-access-token'
});

// 动态 Token
const client = createApiClient({
  basePath: 'https://api.example.com/v1',
  accessToken: () => getAuthToken()
});

API Reference

Users API

• getUsers(params?) - Get all users
• createUser(data) - Create a new user
• getUserById(id) - Get user by ID
• updateUser(id, data) - Update user
• deleteUser(id) - Delete user

Types

All TypeScript types are exported from the main module:

import { User, CreateUserRequest, UpdateUserRequest } from '@yaoyaoyu/og-example-api-client';

Error Handling

import { AxiosError } from 'axios';

try {
  const response = await client.users.getUsers();
} catch (error) {
  if (error instanceof AxiosError) {
    console.error('HTTP Error:', error.response?.status, error.response?.data);
  } else {
    console.error('Unknown Error:', error);
  }
}

License

MIT