使用OpenAPI生成TypeScript客户端指南

最新推荐文章于 2024-08-15 09:35:41 发布

程倩星

最新推荐文章于 2024-08-15 09:35:41 发布

阅读量641

点赞数 21

本文链接：https://blog.csdn.net/gitblog_00103/article/details/141207611

版权

使用OpenAPI生成TypeScript客户端指南

openapi-typescriptGenerate TypeScript types from OpenAPI 3 specs项目地址:https://gitcode.com/gh_mirrors/ope/openapi-typescript

一、项目介绍

该项目旨在帮助开发者从OpenAPI规范中自动生成优雅的TypeScript客户端.通过解析JSON或YAML格式的OpenAPI规范文件(支持版本2.0至3.1),可以生成相应的TypeScript接口,REST客户端及JSON模式等.这不仅简化了前端开发流程还确保了代码的一致性和类型安全.

二、项目快速启动

环境准备

首先确保你的环境中已经安装了Node.js (推荐版本18+) 和 npm 或 yarn.然后通过以下命令全局安装 openapi-typescript

npm install -g openapi-typescript
# 或者使用yarn
yarn global add openapi-typescript

快速启动步骤

假设我们有一个名为 api.yaml 的OpenAPI规范文件在项目根目录下:

第一步: 生成TypeScript定义

运行以下命令来生成TypeScript类型和接口

oats generate api.yaml --out ./src/api

其中 --out 参数指定生成文件的目标目录.

第二步: 使用自动生成的代码

现在你可以在 ./src/api 目录下找到所有自动生成的类型和接口. 例如你可以创建一个 ApiClient.ts 文件并引入生成的代码如下：

import { YourApiInterface } from './YourApiInterface';

const client = new YourApiInterface({
    baseURL: 'http://localhost:3000',
});

// 示例调用
client.getUsers().then((response) => {
    console.log(response.data);
}).catch((error) => {
    console.error(error);
});