openapi2typescript icon indicating copy to clipboard operation
openapi2typescript copied to clipboard

统一返回结构如何使用生成泛型

Open xiaoxuehai opened this issue 1 year ago • 4 comments

image 如上图,每个response返回的结构都是一样的,这里怎么生成统一的泛型

xiaoxuehai avatar Apr 27 '24 14:04 xiaoxuehai

这个应该检查你输出的openapi的json是不是不正确的,理论上来说,2.0下,都会集中定义在definitions下,而3.0则是在Components 对象下,具体参照openapi3.0规范 https://openapi.apifox.cn/

fengluoX avatar Apr 28 '24 14:04 fengluoX

这个应该检查你输出的openapi的json是不是不正确的,理论上来说,2.0下,都会集中定义在definitions下,而3.0则是在Components 对象下,具体参照openapi3.0规范 https://openapi.apifox.cn/

返回的格式是正确的,但是所有的接口response都是一个固定的结构,data,errors,succeeded,statusCode这几个字段都是固定的,但是我发现所有的接口都生成了一遍这个结构,正常我们自己写的话,这个结构的类型是可以写成一个固定的,然后data字段是一个泛型

xiaoxuehai avatar Apr 29 '24 06:04 xiaoxuehai

这个应该检查你输出的openapi的json是不是不正确的,理论上来说,2.0下,都会集中定义在definitions下,而3.0则是在Components 对象下,具体参照openapi3.0规范 https://openapi.apifox.cn/

返回的格式是正确的,但是所有的接口response都是一个固定的结构,data,errors,succeeded,statusCode这几个字段都是固定的,但是我发现所有的接口都生成了一遍这个结构,正常我们自己写的话,这个结构的类型是可以写成一个固定的,然后data字段是一个泛型

可以提交一份你的json文件来看看

fengluoX avatar Apr 29 '24 06:04 fengluoX

这个是否生成统一的范型需要 $ref 去抽象并引用一下,靠工具去判断各种类型是否相等代价太大

rookie-luochao avatar Jul 10 '24 03:07 rookie-luochao