猫咪API SDK

猫TypeScript SDK 1.0.0

欢迎阅读Cats SDK文档。本指南将帮助您开始在项目中集成和使用Cats SDK。

版本

• API版本： 1.0.0
• SDK版本： 1.0.0

关于API

一个开放，免费，读写API所有关于猫

猫API让您可以访问10000个猫的图像和品种。

• 上传您自己的图片
• 获取所有猫品种的详细信息
• 允许您的用户对图像进行收藏或投票
• 为每个请求保存一个自定义值，以便您可以将数据与用户相匹配

我如何访问？

只需从注册API密钥https://thecatapi.com免费。我们期待着看到你建造的东西！ 别忘了结账它的姐妹API-TheDogAPI.com

目录

• 设置和配置
  • 支持的语言版本
  • 安装
• 认证
  • 访问令牌身份验证
• 设置自定义超时
• 示例使用
• 服务
• 模型
• 许可证

设置和配置

支持的语言版本

此SDK与以下版本兼容： TypeScript >= 4.8.4

安装

要开始使用SDK，我们建议使用 npm:

npm install cats

认证

访问令牌身份验证

Cats API使用访问令牌进行身份验证。

必须提供此令牌以验证您对API的请求。

设置访问令牌

初始化SDK时，可以按如下方式设置访问令牌：

const sdk = new Cats({ token: 'YOUR_TOKEN' });

如果在初始化SDK后需要设置或更新访问令牌，可以使用：

const sdk = new Cats();
sdk.token = 'YOUR_TOKEN';

设置自定义超时

您可以为SDK的HTTP请求设置自定义超时，如下所示：

const cats = new Cats({ timeout: 10000 });

示例使用

下面是一个全面的示例，演示如何验证和调用一个简单的端点：

import { Cats } from 'cats';

(async () => {
  const cats = new Cats({
    token: 'YOUR_TOKEN',
  });

  const { data } = await cats.images.imagesListSearchOrRandom({
    size: 'size',
    mimeTypes: 'mime_types',
    format: 'format',
    hasBreeds: true,
    order: 'order',
    page: 2,
    limit: 9,
    contentType: 'Content-Type',
    xApiKey: 'x-api-key',
  });

  console.log(data);
})();

服务

SDK提供各种服务与API进行交互。

模型

SDK包括几个模型，这些模型表示API请求和响应中使用的数据结构。这些模型有助于高效地组织和管理数据。

许可证

此SDK根据MIT许可证获得许可。

请参阅 许可证 文件以获取更多详细信息。