halo/docs
1
0
Fork 0
mirror of https://github.com/halo-dev/docs.git synced 2025-10-22 10:58:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add documentation for RESTful API usage (#412)

Browse Source 
添加 REST API 的使用文档。

Fixes #326 
Fixes #216 


```release-note
None
```
This commit is contained in:
Ryan Wang
2024-09-09 17:34:05 +08:00
committed by GitHub
parent 3aadde1218
commit 5608dedd2b
17 changed files with 538 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
versioned_docs/version-2.19/developer-guide/plugin/api-reference/ui/api-request.md
View File

@@ -29,14 +29,14 @@ 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，需要传入 axios 实例。
- **createConsoleApiClient**: 用于创建 Console 接口封装的 api client，需要传入 axios 实例。
- **createUcApiClient**: 用于创建 UC 接口封装的 api client，需要传入 axios 实例。
- **createPublicApiClient**: 用于创建公开访问接口封装的 api client，需要传入 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 实例。
## 使用

2
versioned_docs/version-2.19/developer-guide/plugin/introduction.md
View File

@@ -1,6 +1,6 @@
---
title: 介绍
description: 插件开发的准备工作
description: Halo 插件机制的简介
---
Halo 采用可插拔架构，功能模块之间耦合度低、灵活性提高，支持用户按需安装、卸载插件，操作便捷。同时提供插件开发接口以确保较高扩展性和可维护性，这个系列的文档将帮助你了解如何开发 Halo 插件。