開始使用
首先說明 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/授權、CSR 緩存和 SSR 緩存,可以擴展如下。這個檔案也不是自動生成的,而是專案代碼。
rxjsHttpService.ts
ts4. 選擇:使用 Swagger 自動生成的服務的情況
連接 OpenAPI 服務生成器後,界面不會重新編寫 URL 和響應類型。導入生成的函數並僅傳遞所需的路徑、參數和主體。