Swagger Axios Codegen 使用教程

Swagger Axios Codegen 使用教程

swagger-axios-codegen swagger client to use axios and typescript 项目地址: https://gitcode.com/gh_mirrors/sw/swagger-axios-codegen

1. 项目介绍

swagger-axios-codegen 是一个基于 Swagger 规范生成 TypeScript 客户端代码的工具。它使用 Axios 作为 HTTP 客户端，并支持生成静态方法、自定义 Axios 实例、以及使用第三方库如 Fly.js 等功能。生成的代码可以直接在项目中使用，简化了与后端 API 的交互过程。

2. 项目快速启动

安装

首先，通过 npm 安装 swagger-axios-codegen：

npm install swagger-axios-codegen

使用本地 Swagger 文件生成代码

假设你有一个本地的 Swagger JSON 文件 swagger.json，你可以使用以下代码生成 TypeScript 客户端代码：

const { codegen } = require('swagger-axios-codegen');

codegen({
  methodNameMode: 'operationId',
  source: require('./swagger.json'),
  outputDir: './generated-service',
  useStaticMethod: true
});

使用远程 Swagger 文件生成代码

如果你有一个远程的 Swagger JSON 文件，可以使用 remoteUrl 参数：

const { codegen } = require('swagger-axios-codegen');

codegen({
  methodNameMode: 'operationId',
  remoteUrl: 'http://your-api-url/swagger/v1/swagger.json',
  outputDir: './generated-service',
  useStaticMethod: true
});

使用生成的代码

生成的代码会放在 outputDir 指定的目录中。你可以在项目中直接导入并使用这些服务：

import { UserService } from './generated-service';

async function fetchUsers() {
  const users = await UserService.GetAll();
  console.log(users);
}

fetchUsers();

3. 应用案例和最佳实践

自定义 Axios 实例

在某些情况下，你可能需要使用自定义的 Axios 实例来配置请求头、超时时间等。可以通过以下方式实现：

import axios from 'axios';
import { serviceOptions } from './generated-service';

const instance = axios.create({
  baseURL: 'https://api.example.com',
  timeout: 1000,
  headers: { 'X-Custom-Header': 'foobar' }
});

serviceOptions.axios = instance;

使用第三方库

如果你不想使用 Axios，可以配置 useCustomerRequestInstance 参数，并使用其他 HTTP 客户端库，如 Fly.js：

import Fly from 'flyio';
import { serviceOptions } from './generated-service';

const fly = new Fly();
serviceOptions.axios = fly;

4. 典型生态项目

Swagger UI

Swagger UI 是一个用于可视化 Swagger 文档的工具，可以帮助开发者更好地理解和测试 API。你可以将生成的 Swagger JSON 文件导入 Swagger UI 中进行查看和测试。

TypeScript

TypeScript 是 JavaScript 的超集，提供了静态类型检查和更强大的工具支持。swagger-axios-codegen 生成的代码是 TypeScript 代码，可以直接在 TypeScript 项目中使用。

Axios

Axios 是一个基于 Promise 的 HTTP 客户端，支持浏览器和 Node.js。swagger-axios-codegen 默认使用 Axios 作为 HTTP 客户端，生成的代码可以直接与 Axios 集成。

通过以上步骤，你可以快速上手并使用 swagger-axios-codegen 生成 TypeScript 客户端代码，简化与后端 API 的交互过程。

swagger-axios-codegen swagger client to use axios and typescript 项目地址: https://gitcode.com/gh_mirrors/sw/swagger-axios-codegen