使用Ant Design Pro开发时的一个快速开发接口的技巧
当我们的后端在写好接口以后,我们通过swagger + knife4j可以生成一个接口文档,后端启动以后,可以生成一个接口文档,当输入地址 localhost:8101/api/v3/api-docs
(这里重要的地址是后面的/v3/api-docs
,前面的就需要根据自己电脑后端端口以及地址改变)就可以访问openapi规范的接口文档了。然后我在前端只要把这个地址喂给前端,在前端就可以生成接口方法,如果是ts的就会有相应的类型定义。
现在我们来实操一下。
配置
首先在ant Design Pro框架生成的代码中,找到 config 下面的 config.ts 在文件中找到openAPI 部分,然后对openAPI 中的内容进行一个修改。
reqeustPath
这个不用管,它直接不改就行了
schemaPath
这个就是 api-docs 的地址
projectName
: 就是取得接口项目名字
运行
这里配置好了就可以到 package.json
文件中找一个运行的入口,openapi,点击绿色的开始就行了,然后他就会帮你生成好你想要的接口请求,以及类型定义。
出现结果: