开始
首先说明typed-rx-http Core客户端本身的用法,然后说明在需要的项目中如何连接项目拥有的公共HTTP适配器和Swagger自动生成服务。
1. 安装
2. 直接使用 Core client,无需自动生成
首先,最基本的用法是 createHttpClient<Paths>()先创建一次 client,然后调用该 client 的 callApi。Paths 通常是 OpenAPI 生成的 paths 类型,但也可以使用与之兼容的自定义类型。
httpClient.ts
ts3. 选择:rxjsHttpService/commonService是什么
文档中称为rxjsHttpService.ts或commonService.ts的文件并不是库自动生成的固定文件名,而是项目直接拥有的HTTP适配器文件。多个自动生成的REST服务不需要各自创建createHttpClient,而是使用此文件导出的callApi/callApiStream/cache函数作为公共入口点。
最简单的形式是像下面的完整代码一样,创建headerStore和createHttpClient一次,并将库的方法重新导出为项目函数。如果自动生成的服务不使用缓存功能,仅凭这一配置就能理解结构。
rxjsHttpService.ts
ts在实际的Next.js项目中,要在一个文件中共同处理会话认证、SSR请求的Cookie/Authorization、CSR缓存和SSR缓存,可以扩展如下。这文件也不是自动生成的,而是项目代码。
rxjsHttpService.ts
ts4. 选择:使用Swagger自动生成服务的情况
连接 OpenAPI 服务生成器后,界面不再重新编写 URL 和响应类型。导入生成的函数,并仅传递所需的路径、参数和主体。