GPT中文小秘书挑几下就能开工
我积分

照接口文档生成请求代码

关于「照接口文档生成请求代码」:能拿到什么、要点选什么、怎么办

接口文档一键变请求代码和类型。接口请求代码生成是读接口文档或返回样例,产出请求函数、类型定义和状态处理;在 GPT中文网点选几项,能直接拿到可用的代码模块。

能拿到什么

  • 推荐:接口请求模块代码包(含请求函数、TS 类型、加载/失败/空态处理模板的代码文件)

要你点选的几项

文档来源、上传接口文档或样例、请求库、类型风格、鉴权方式、要处理的状态、错误码处理、字段含义补充。多数点一下就行,没选的按常见情况替你定,交付时说清哪几项是按默认的。

怎么办

  1. 上传接口文档或返回样例,选请求库和类型风格
  2. 勾选要处理的状态并补充错误码、字段含义
  3. 生成后核对字段是否必填、错误码是否覆盖
  4. 把代码放进项目,联调时再微调

别人还这样说

  • 照这份接口文档生成 Axios 请求函数,带上 loading 和错误处理
  • 我有一份返回样例,帮我生成 TS 类型和请求模块
直接说你要办的事。下面是别人怎么办的,点任何一项就换成你自己的。左边是别人怎么办的,右边是你的,点一项就开始改。
示范 · 别人这样说

「把这个 Swagger 导出的 JSON 变成请求代码和类型」

替他选了:Swagger 导出

按示范选好的 点一项就变成你的

你的成品会在这里出现
示例成品 · 不是你的按示范写的,看个样子
示例:接口请求模块代码(示意) // types/user.ts export interface GetUserParams { userId: string; // 用户 ID,必填 } export interface GetUserResponse { code: number; message: string; data: { userId: string; userName: string; phone: string; }; } // api/user.ts import axios from 'axios'; import { GetUserParams, GetUserResponse } from '../types/user'; export async function getUser(params: GetUserParams): Promise<GetUserResponse> { const res = await axios.get('/api/user', { params, headers: { Authorization: `Bearer ${localStorage.getItem('token')}` }, }); if (res.data.code !== 0) { throw new Error(res.data.message || '请求失败'); } return res.data; } // hooks/useUser.ts 状态处理模板 export function useUser(userId: string) { const [loading, setLoading] = useState(false); const [error, setError] = useState<string | null>(null); const [data, setData] = useState<GetUserResponse['data'] | null>(null); useEffect(() => { setLoading(true); getUser({ userId }) .then((res) => setData(res.data)) .catch((e) => setError(e.message)) .finally(() => setLoading(false)); }, [userId]); return { loading, error, data, isEmpty: !data }; } 字段说明 | 含义

GPT中文 也可能出错,成品请自己核对关键数字和事实。条款 · 隐私