uapi-browser-sdk 0.1.0

package/internal/docs/StatusApi.md

@@ -0,0 +1,148 @@
+# StatusApi
+
+All URIs are relative to *https://uapis.cn/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getStatusRatelimit**](StatusApi.md#getstatusratelimit) | **GET** /status/ratelimit | 获取API限流器实时状态 |
+| [**getStatusUsage**](StatusApi.md#getstatususage) | **GET** /status/usage | 获取API端点使用统计 |
+
+
+
+## getStatusRatelimit
+
+> GetStatusRatelimit200Response getStatusRatelimit(authorization)
+
+获取API限流器实时状态
+
+想了解我们API的当前负载情况吗？这个接口为你提供了服务的“心电图”。  ## 功能概述 此接口返回我们后端自适应限流器的实时状态。你可以看到当前并发请求数、并发上限、系统负载、请求接受/拒绝数等核心指标。这对于监控API健康状况和性能表现至关重要。  > [!IMPORTANT] > 此接口为管理接口，需要提供有效的管理员级别API密钥才能访问。  ### 认证方式 请在请求头中添加 `Authorization: Bearer <你的API密钥>`。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StatusApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetStatusRatelimitRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new StatusApi();
+
+  const body = {
+    // string | Bearer类型的API密钥认证头。例如：`Bearer sk-xxx`
+    authorization: Bearer sk-xxx,
+  } satisfies GetStatusRatelimitRequest;
+
+  try {
+    const data = await api.getStatusRatelimit(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **authorization** | `string` | Bearer类型的API密钥认证头。例如：`Bearer sk-xxx` | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetStatusRatelimit200Response**](GetStatusRatelimit200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 查询成功，返回限流器的详细状态数据。 |  -  |
+| **401** | 未授权 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getStatusUsage
+
+> GetStatusUsage200Response getStatusUsage(path)
+
+获取API端点使用统计
+
+想知道哪个API接口最受欢迎吗？这个接口提供了详细的“账单”。  ## 功能概述 此接口用于获取每个API端点（Endpoint）的使用情况统计。你可以查询所有端点的列表，也可以通过 `path` 参数指定查询某一个特定端点。返回信息包括调用次数和平均处理时长
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StatusApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetStatusUsageRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new StatusApi();
+
+  const body = {
+    // string | （可选）如果你想查询某个特定的端点，请提供它的路径，例如 \'/api/v1/image/motou\'。如果留空，则返回所有端点的统计列表。 (optional)
+    path: /api/v1/image/motou,
+  } satisfies GetStatusUsageRequest;
+
+  try {
+    const data = await api.getStatusUsage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **path** | `string` | （可选）如果你想查询某个特定的端点，请提供它的路径，例如 \'/api/v1/image/motou\'。如果留空，则返回所有端点的统计列表。 | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**GetStatusUsage200Response**](GetStatusUsage200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 当查询所有路径时 |  -  |
+| **401** | 未授权 |  -  |
+| **404** | 未找到指定路径的统计数据 |  -  |
+| **500** | 服务器内部错误 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/internal/docs/TextApi.md

@@ -0,0 +1,562 @@
+# TextApi
+
+All URIs are relative to *https://uapis.cn/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getTextMd5**](TextApi.md#gettextmd5) | **GET** /text/md5 | 计算文本的MD5哈希值(GET) |
+| [**postTextAesDecrypt**](TextApi.md#posttextaesdecryptoperation) | **POST** /text/aes/decrypt | 使用AES算法解密文本 |
+| [**postTextAesEncrypt**](TextApi.md#posttextaesencryptoperation) | **POST** /text/aes/encrypt | 使用AES算法加密文本 |
+| [**postTextAnalyze**](TextApi.md#posttextanalyzeoperation) | **POST** /text/analyze | 多维度分析文本内容 |
+| [**postTextBase64Decode**](TextApi.md#posttextbase64decodeoperation) | **POST** /text/base64/decode | 解码Base64编码的文本 |
+| [**postTextBase64Encode**](TextApi.md#posttextbase64encodeoperation) | **POST** /text/base64/encode | 将文本进行Base64编码 |
+| [**postTextMd5**](TextApi.md#posttextmd5operation) | **POST** /text/md5 | 计算文本的MD5哈希值 (POST) |
+| [**postTextMd5Verify**](TextApi.md#posttextmd5verifyoperation) | **POST** /text/md5/verify | 校验MD5哈希值 |
+
+
+
+## getTextMd5
+
+> GetTextMd5200Response getTextMd5(text)
+
+计算文本的MD5哈希值(GET)
+
+一个快速计算文本 MD5 哈希值的工具，适用于短文本且不关心参数暴露的场景。  ## 功能概述 通过GET请求的查询参数传入文本，返回其32位小写的MD5哈希值。  > [!NOTE] > 对于较长或敏感的文本，我们推荐使用本接口的 POST 版本，以避免URL长度限制和参数暴露问题。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TextApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetTextMd5Request } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new TextApi();
+
+  const body = {
+    // string | 需要计算哈希值的文本
+    text: hello world,
+  } satisfies GetTextMd5Request;
+
+  try {
+    const data = await api.getTextMd5(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **text** | `string` | 需要计算哈希值的文本 | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetTextMd5200Response**](GetTextMd5200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功响应 |  -  |
+| **400** | 缺少text参数 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postTextAesDecrypt
+
+> PostTextAesDecrypt200Response postTextAesDecrypt(postTextAesDecryptRequest)
+
+使用AES算法解密文本
+
+收到了用AES加密的密文？把它、密钥和随机数（nonce）交给我们，就能还原出原始内容。  ## 功能概述 这是一个标准的AES解密接口。你需要提供经过Base64编码的密文、加密时使用的密钥和nonce（随机数，通常为16字节字符串）。  > [!IMPORTANT] > **关于密钥 `key`** > 我们支持 AES-128, AES-192, 和 AES-256。请确保你提供的密钥 `key` 的长度（字节数）正好是 **16**、**24** 或 **32**，以分别对应这三种加密强度。 >  > **关于随机数 `nonce`** > 通常为16字节字符串，需与加密时一致。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TextApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostTextAesDecryptOperationRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new TextApi();
+
+  const body = {
+    // PostTextAesDecryptRequest | 包含待解密文本 \'text\'、密钥 \'key\' 和随机数 \'nonce\' 的JSON对象
+    postTextAesDecryptRequest: ...,
+  } satisfies PostTextAesDecryptOperationRequest;
+
+  try {
+    const data = await api.postTextAesDecrypt(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postTextAesDecryptRequest** | [PostTextAesDecryptRequest](PostTextAesDecryptRequest.md) | 包含待解密文本 \'text\'、密钥 \'key\' 和随机数 \'nonce\' 的JSON对象 | |
+
+### Return type
+
+[**PostTextAesDecrypt200Response**](PostTextAesDecrypt200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功响应 |  -  |
+| **400** | 无效的请求参数 |  -  |
+| **500** | 解密失败 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postTextAesEncrypt
+
+> PostTextAesEncrypt200Response postTextAesEncrypt(postTextAesEncryptRequest)
+
+使用AES算法加密文本
+
+需要安全地传输或存储一些文本信息？AES加密是一个可靠的选择。  ## 功能概述 这是一个标准的AES加密接口。你提供需要加密的明文和密钥，我们返回经过Base64编码的密文。  > [!IMPORTANT] > **关于密钥 `key`** > 我们支持 AES-128, AES-192, 和 AES-256。请确保你提供的密钥 `key` 的长度（字节数）正好是 **16**、**24** 或 **32**，以分别对应这三种加密强度。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TextApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostTextAesEncryptOperationRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new TextApi();
+
+  const body = {
+    // PostTextAesEncryptRequest | 包含待加密文本 \'text\' 和密钥 \'key\' 的JSON对象
+    postTextAesEncryptRequest: ...,
+  } satisfies PostTextAesEncryptOperationRequest;
+
+  try {
+    const data = await api.postTextAesEncrypt(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postTextAesEncryptRequest** | [PostTextAesEncryptRequest](PostTextAesEncryptRequest.md) | 包含待加密文本 \'text\' 和密钥 \'key\' 的JSON对象 | |
+
+### Return type
+
+[**PostTextAesEncrypt200Response**](PostTextAesEncrypt200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功响应 |  -  |
+| **400** | 无效的请求参数 |  -  |
+| **500** | 加密失败 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postTextAnalyze
+
+> PostTextAnalyze200Response postTextAnalyze(postTextAnalyzeRequest)
+
+多维度分析文本内容
+
+想知道一篇文章有多少字、多少个词、或者多少行？这个接口可以帮你快速统计。  ## 功能概述 你提供一段文本，我们会从多个维度进行分析，并返回其字符数、词数、句子数、段落数和行数。这对于文本编辑、内容管理等场景非常有用。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TextApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostTextAnalyzeOperationRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new TextApi();
+
+  const body = {
+    // PostTextAnalyzeRequest | 包含待分析文本 \'text\' 的JSON对象
+    postTextAnalyzeRequest: ...,
+  } satisfies PostTextAnalyzeOperationRequest;
+
+  try {
+    const data = await api.postTextAnalyze(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postTextAnalyzeRequest** | [PostTextAnalyzeRequest](PostTextAnalyzeRequest.md) | 包含待分析文本 \'text\' 的JSON对象 | |
+
+### Return type
+
+[**PostTextAnalyze200Response**](PostTextAnalyze200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功响应 |  -  |
+| **400** | 请求体无效或文本为空 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postTextBase64Decode
+
+> PostTextBase64Decode200Response postTextBase64Decode(postTextBase64DecodeRequest)
+
+解码Base64编码的文本
+
+这是一个简单实用的 Base64 解码工具。  ## 功能概述 你提供一个 Base64 编码的字符串，我们帮你解码成原始的 UTF-8 文本。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TextApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostTextBase64DecodeOperationRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new TextApi();
+
+  const body = {
+    // PostTextBase64DecodeRequest | 包含待解码文本 \'text\' 的JSON对象
+    postTextBase64DecodeRequest: ...,
+  } satisfies PostTextBase64DecodeOperationRequest;
+
+  try {
+    const data = await api.postTextBase64Decode(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postTextBase64DecodeRequest** | [PostTextBase64DecodeRequest](PostTextBase64DecodeRequest.md) | 包含待解码文本 \'text\' 的JSON对象 | |
+
+### Return type
+
+[**PostTextBase64Decode200Response**](PostTextBase64Decode200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功响应 |  -  |
+| **400** | 无效的请求参数或解码失败 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postTextBase64Encode
+
+> PostTextBase64Encode200Response postTextBase64Encode(postTextBase64EncodeRequest)
+
+将文本进行Base64编码
+
+这是一个简单实用的 Base64 编码工具。  ## 功能概述 你提供一段原始文本，我们帮你转换成 Base64 编码的字符串。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TextApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostTextBase64EncodeOperationRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new TextApi();
+
+  const body = {
+    // PostTextBase64EncodeRequest | 包含待编码文本 \'text\' 的JSON对象
+    postTextBase64EncodeRequest: ...,
+  } satisfies PostTextBase64EncodeOperationRequest;
+
+  try {
+    const data = await api.postTextBase64Encode(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postTextBase64EncodeRequest** | [PostTextBase64EncodeRequest](PostTextBase64EncodeRequest.md) | 包含待编码文本 \'text\' 的JSON对象 | |
+
+### Return type
+
+[**PostTextBase64Encode200Response**](PostTextBase64Encode200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功响应 |  -  |
+| **400** | 无效的请求参数 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postTextMd5
+
+> GetTextMd5200Response postTextMd5(postTextMd5Request)
+
+计算文本的MD5哈希值 (POST)
+
+一个用于计算文本 MD5 哈希值的标准工具，推荐使用此版本。  ## 功能概述 通过POST请求的表单体传入文本，返回其32位小写的MD5哈希值。相比GET版本，此方法更适合处理较长或包含敏感信息的文本。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TextApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostTextMd5OperationRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new TextApi();
+
+  const body = {
+    // PostTextMd5Request
+    postTextMd5Request: ...,
+  } satisfies PostTextMd5OperationRequest;
+
+  try {
+    const data = await api.postTextMd5(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postTextMd5Request** | [PostTextMd5Request](PostTextMd5Request.md) |  | |
+
+### Return type
+
+[**GetTextMd5200Response**](GetTextMd5200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功响应 |  -  |
+| **400** | 缺少text参数 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postTextMd5Verify
+
+> PostTextMd5Verify200Response postTextMd5Verify(postTextMd5VerifyRequest)
+
+校验MD5哈希值
+
+下载了一个文件，想确认它在传输过程中有没有损坏？校验MD5值是最常用的方法。  ## 功能概述 你提供原始文本和一个MD5哈希值，我们帮你计算文本的哈希，并与你提供的哈希进行比对，告诉你它们是否匹配。这在文件完整性校验等场景下非常有用。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TextApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostTextMd5VerifyOperationRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new TextApi();
+
+  const body = {
+    // PostTextMd5VerifyRequest | 包含待校验文本 \'text\' 和哈希值 \'hash\' 的JSON对象
+    postTextMd5VerifyRequest: ...,
+  } satisfies PostTextMd5VerifyOperationRequest;
+
+  try {
+    const data = await api.postTextMd5Verify(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postTextMd5VerifyRequest** | [PostTextMd5VerifyRequest](PostTextMd5VerifyRequest.md) | 包含待校验文本 \'text\' 和哈希值 \'hash\' 的JSON对象 | |
+
+### Return type
+
+[**PostTextMd5Verify200Response**](PostTextMd5Verify200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功响应 |  -  |
+| **400** | 无效的请求参数 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+