docs: update readme for api client package (#6167)

#### What type of PR is this?

/area ui
/kind documentation
/milestone 2.17.x

#### What this PR does / why we need it:

更新 `@halo-dev/api-client` 包的 readme。

#### Does this PR introduce a user-facing change?

```release-note
None
```
pull/6140/head^2
Ryan Wang 2024-06-27 15:16:54 +08:00 committed by GitHub
parent cc36ddaec5
commit f277655e11
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 11 deletions

View File

@ -18,15 +18,15 @@ import {
} from "@halo-dev/api-client"
```
- coreApiClient: 为 Halo 所有自定义模型的 CRUD 接口封装的 api client。
- consoleApiClient: 为 Halo 针对 Console 提供的接口封装的 api client。
- ucApiClient: 为 Halo 针对 UC 提供的接口封装的 api client。
- publicApiClient: 为 Halo 所有公开访问的接口封装的 api client。
- createCoreApiClient: 用于创建自定义模型的 CRUD 接口封装的 api client需要传入 baseURL 和 axios 实例。
- createConsoleApiClient: 用于创建 Console 接口封装的 api client需要传入 baseURL 和 axios 实例。
- createUcApiClient: 用于创建 UC 接口封装的 api client需要传入 baseURL 和 axios 实例。
- createPublicApiClient: 用于创建公开访问接口封装的 api client需要传入 baseURL 和 axios 实例。
- axiosInstance: 内部默认创建的 axios 实例。
- **coreApiClient**: 为 Halo 所有自定义模型的 CRUD 接口封装的 api client。
- **consoleApiClient**: 为 Halo 针对 Console 提供的接口封装的 api client。
- **ucApiClient**: 为 Halo 针对 UC 提供的接口封装的 api client。
- **publicApiClient**: 为 Halo 所有公开访问的接口封装的 api client。
- **createCoreApiClient**: 用于创建自定义模型的 CRUD 接口封装的 api client需要传入 axios 实例。
- **createConsoleApiClient**: 用于创建 Console 接口封装的 api client需要传入 axios 实例。
- **createUcApiClient**: 用于创建 UC 接口封装的 api client需要传入 axios 实例。
- **createPublicApiClient**: 用于创建公开访问接口封装的 api client需要传入 axios 实例。
- **axiosInstance**: 内部默认创建的 axios 实例。
### 在插件中使用
@ -39,13 +39,15 @@ pnpm install @halo-dev/api-client axios
```javascript
import { coreApiClient } from "@halo-dev/api-client"
coreApiClient.content.post.listContentHaloRunV1alpha1Post().then(response => {
coreApiClient.content.post.listPost().then(response => {
// handle response
})
```
此外,在最新的 `@halo-dev/ui-plugin-bundler-kit@2.17.0` 中,已经排除了 `@halo-dev/api-client`、`axios` 依赖,所以最终产物中的相关依赖会自动使用 Halo 本身提供的依赖,无需关心最终产物大小。
详细文档可查阅:[插件开发 / API 请求](https://docs.halo.run/developer-guide/plugin/api-reference/ui/api-request)
### 在外部项目中使用
```shell
@ -61,7 +63,7 @@ const axiosInstance = axios.create({
const coreApiClient = createCoreApiClient(axiosInstance)
coreApiClient.content.post.listContentHaloRunV1alpha1Post().then(response => {
coreApiClient.content.post.listPost().then(response => {
// handle response
})
```