简介

什么是 Api-Typing？

Api-Typing 是一个基于 axios 的强类型提示的 http 框架，它提供了包括 url、接口入参、接口回参的类型提示支持。

为什么会有这个项目？

接口的对接在前端的工作中占据了很大一部分时间，我们在接口对接时经常会遇到以下这些情况：

• 不小心写错了接口字段（ url 拼写错误，入参，回参错误）。
• 后端接口变更了（可能是 url，入参，或者回参），但是没有通知到前端。

这些错误可能不会立即被暴露出来，直到测试时才会被发现，但是如果项目已经有了完善的 swagger 文档或者其他基于 openapi 协议的文档的话，那么就完全可以在编写接口的时候将这些错误排除掉。那么完成整个逻辑的链条就是 openapi > typescript > 全自动的类型提示。

项目的目标是什么？

由于axios提供了很完善的底层功能，那么这个项目的目标就是尽量兼容axios的接口，并且在其基础上提供更完善的类型支持。所以如果你的项目对axios有封装的话，该项目会提供尽可能平滑的使用体验。