jsDelivr API 使用教程

jsDelivr API 使用教程

1. 项目介绍

jsDelivr API 是一个公共的 API，用于获取 npm 包的文件、版本、入口点以及它们的 CDN URL 和下载统计数据。该 API 是免费的，并且没有速率限制。然而，如果你计划在较长的时间内每分钟请求超过 100 次（RPM），你应该首先联系我们。请注意，使用统计数据有 48 小时的延迟，并且我们只从 2017 年 8 月 19 日开始有数据，超过一年的数据可能不可用。

2. 项目快速启动

2.1 安装依赖

首先，克隆项目到本地：

git clone https://github.com/jsdelivr/data.jsdelivr.com.git
cd data.jsdelivr.com

2.2 配置环境变量

在项目根目录下创建一个 .env 文件，并添加以下内容：

SERVER_PORT=4454
SERVER_DEBUG_TOKEN=your_debug_token
DB_CONNECTION_HOST=localhost
DB_CONNECTION_PORT=3306
DB_CONNECTION_USER=your_db_user
DB_CONNECTION_PASSWORD=your_db_password
DB_CONNECTION_DATABASE=jsdelivr-stats
REDIS_DB=0
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=your_redis_password
V_1_GH_API_TOKEN=your_github_api_token
ELASTIC_APM_SERVER_URL=your_elastic_apm_server_url
ELASTIC_APM_SECRET_TOKEN=your_elastic_apm_secret_token
ELASTIC_SEARCH_URL=your_elastic_search_url
NODE_ENV=production

2.3 启动项目

安装依赖并启动项目：

npm install
npm start

项目启动后，API 将在 http://localhost:4454 上运行。

3. 应用案例和最佳实践

3.1 获取 npm 包信息

你可以使用以下 API 端点获取 npm 包的信息：

curl http://localhost:4454/v1/packages/npm/express

3.2 获取文件下载统计

获取特定文件的下载统计数据：

curl http://localhost:4454/v1/stats/files/npm/express/latest/index.js

3.3 最佳实践

• 缓存数据：由于 API 没有速率限制，建议在客户端缓存数据以减少请求次数。
• 错误处理：在生产环境中，确保对 API 请求进行适当的错误处理，以防止服务中断。

4. 典型生态项目

4.1 jsDelivr CDN

jsDelivr CDN 是一个公共的 CDN，支持 npm、GitHub 和其他平台的文件分发。它与 jsDelivr API 紧密集成，允许开发者轻松获取和分发文件。

4.2 jsDelivr 网站

jsDelivr 网站提供了用户友好的界面，用于浏览和搜索 npm 包及其文件。它使用 jsDelivr API 来获取和显示数据。

4.3 其他工具

• npm-search：一个基于 Algolia 的 npm 包搜索工具，提供更快的搜索体验。
• npm-stats：一个用于分析 npm 包下载统计的工具，使用 jsDelivr API 获取数据。

通过这些生态项目，开发者可以更高效地管理和分发他们的 npm 包。