基于 Pipeline 的 TS/JS API 代码自动生成（apipgen）

最新推荐文章于 2024-07-12 11:08:24 发布

qq_38414743

最新推荐文章于 2024-07-12 11:08:24 发布

阅读量322

点赞数

文章标签： javascript 前端自动化 typescript

本文链接：https://blog.csdn.net/qq_38414743/article/details/129213788

版权

apipgen是一个API生成工具，能够根据后端提供的接口描述（如Swagger）自动生成TypeScript或JavaScript的API函数及类型定义，减少手动编写的工作量。该工具支持多种输入源和管道，包括Swagger转Javascript Axios，并允许用户自定义拦截器和导入路径。通过配置文件，用户可以指定输入输出内容，并通过npm包或本地路径定义处理管道。

摘要由CSDN通过智能技术生成

大家写项目的时候联调对接后端，写相应的 API 函数的时候会不会觉得很麻烦，我是这么觉得的，如果使用的 Typescript ，确保和后端的类型保持一致，还要手写类型，接口请求和返回参数定义类型成了繁琐的一件事情。

如果后端有提供接口描述的数据源（swagger、yapi 或其他源）等等，我们就可以利用 aippgen 自动的生成接口与类型。

/**
 * @summary uploads an image
 * @method post
 */
export function postPetPetIdUploadImage(data: FormData, paths: OpenAPITypes.PostPetPetIdUploadImagePath, config?: AxiosRequestConfig) {
   
  const url = `/pet/${
     paths?.petId}/uploadImage`
  http.request<Response<OpenAPITypes.ApiResponse>>({
    url, data, ...config })
}
/**
 * @summary Add a new pet to the store
 * @method post
 */
export function postPet(data: OpenAPITypes.Pet, config?: AxiosRequestConfig) {
   
  const url = '/pet'
  http.request<Response<void>>({
    url, data, ...config })
}


export type Response<T> = T;

export interface ApiResponse {
   
  code?: number;
  type?: string;
  message?: string;
}
export interface Category {
   
  id?: number;
  name?: string;
}
export interface Pet {
   
  id?: number