npm API

Tier: 基础版，专业版，旗舰版
Offering: JihuLab.com，私有化部署

这是 npm 软件包的 API 文档。

此 API 由 [npm 软件包管理器客户端](https://docs.npmjs.com/) 使用，并不适用于手动使用。

关于如何从极狐GitLab 软件包注册表上传和安装 npm 软件包的说明，请参见 npm 软件包注册表文档。

这些端点不遵循标准的 API 身份验证方法。有关支持的标头和令牌类型的详细信息，请参见 [npm 软件包注册表文档](../../user/packages/npm_registry/_index.md)。未来可能会移除未记录的身份验证方法。

下载软件包#

下载 npm 软件包。此 URL 由 metadata endpoint 提供。

plaintext
GET projects/:id/packages/npm/:package_name/-/:file_name

属性	类型	必需	描述
id	string	yes	项目的 ID 或完整路径
package_name	string	yes	软件包的名称
file_name	string	yes	软件包文件的名称

shell
curl --header "Authorization: Bearer <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/npm/@myscope/my-pkg/-/@my-scope/my-pkg-0.0.1.tgz"

将输出写入文件：

shell
curl --header "Authorization: Bearer <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/npm/@myscope/my-pkg/-/@my-scope/my-pkg-0.0.1.tgz" >> @myscope/my-pkg-0.0.1.tgz

这会将下载的文件写入当前目录中的 @myscope/my-pkg-0.0.1.tgz。

上传软件包文件#

上传软件包。

plaintext
PUT projects/:id/packages/npm/:package_name

属性	类型	必需	描述
id	string	yes	项目的 ID 或完整路径
package_name	string	yes	软件包的名称
versions	string	yes	软件包版本信息

shell
curl --request PUT
     --header "Content-Type: application/json"
     --data @./path/to/metadata/file.json
     --header "Authorization: Bearer <personal_access_token>" \
     "https://gitlab.example.com/api/v4/projects/1/packages/npm/@myscope%2fmy-pkg"

元数据文件内容由 npm 生成，但看起来像这样：

json
1{
2    "_attachments": {
3        "@myscope/my-pkg-1.3.7.tgz": {
4            "content_type": "application/octet-stream",
5            "data": "H4sIAAAAAAAAE+1TQUvDMBjdeb/iI4edZEldV2dPwhARPIjiyXlI26zN1iYhSeeK7L+bNJtednMg4l4OKe+9PF7DF0XzNS0ZVmEfr4wUgxODEJLEMRzjPRJyCYPJNCFRlCTE+dzH1PvJqYscQ2ss1a7KT3PCv8DX/kfwMQRAgjYMpYBuIoIzKtwy6MILG6YNl8Jr0XgyvgpswUyuubJ75TGMDuSaUcsKyDooa1C6De6G8t7GRcG2br4CGxKME3wDR1hmrLexvJKwQLdaS52CkOAFMIrlfMlZsUAwGgHbcgsRcid3fdqade9SFz7u9a1naGsrqX3gHbcPNINDyydWcmN1By+W19x2oU7NcyZMfwn3z/PAqTaruanmUix5+V3UXVKq9yEoRZW1yqQYl9zWNBvnssFUcbyJsdJyxXJrcHQdz8gsTg6PzGChGty3H+6Gvz0BZ5xxxn/FJ1EDRNIACAAA",
6            "length": 354
7        }
8    },
9    "_id": "@myscope/my-pkg",
10    "description": "Package created by me",
11    "dist-tags": {
12        "latest": "1.3.7"
13    },
14    "name": "@myscope/my-pkg",
15    "readme": "ERROR: No README data found!",
16    "versions": {
17        "1.3.7": {
18            "_id": "@myscope/my-pkg@1.3.7",
19            "_nodeVersion": "12.18.4",
20            "_npmVersion": "6.14.6",
21            "author": {
22                "name": "极狐GitLab 软件包注册表 Utility"
23            },
24            "description": "Package created by me",
25            "dist": {
26                "integrity": "sha512-loy16p+Dtw2S43lBmD3Nye+t+Vwv7Tbhv143UN2mwcjaHJyBfGZdNCTXnma3gJCUSE/AR4FPGWEyCOOTJ+ev9g==",
27                "shasum": "4a9dbd94ca6093feda03d909f3d7e6bd89d9d4bf",
28                "tarball": "https://gitlab.example.com/api/v4/projects/1/packages/npm/@myscope/my-pkg/-/@myscope/my-pkg-1.3.7.tgz"
29            },
30            "keywords": [],
31            "license": "ISC",
32            "main": "index.js",
33            "name": "@myscope/my-pkg",
34            "publishConfig": {
35                "@myscope:registry": "https://gitlab.example.com/api/v4/projects/1/packages/npm"
36            },
37            "readme": "ERROR: No README data found!",
38            "scripts": {
39                "test": "echo \"Error: no test specified\" && exit 1"
40            },
41            "version": "1.3.7"
42        }
43    }
44}

路由前缀#

对于剩余的路由，有两组相同的路由，每个路由在不同的范围内发出请求：

使用实例级别的前缀在整个实例的范围内发出请求。
使用项目级别的前缀在单个项目的范围内发出请求。
使用群组级别的前缀在群组的范围内发出请求。

此文档中的示例均使用项目级别的前缀。

实例级别#

plaintext
/packages/npm

项目级别#

plaintext
/projects/:id/packages/npm

属性	类型	必需	描述
id	string	yes	项目 ID 或完整项目路径

群组级别#

History

引入于极狐GitLab 16.0，使用名为 npm_group_level_endpoints 的功能标志。默认禁用。
在极狐GitLab 16.1 中 GA。功能标志 npm_group_level_endpoints 被移除。

plaintext
/groups/:id/-/packages/npm

属性	类型	必需	描述
id	string	yes	群组 ID 或完整群组路径

元数据#

返回给定软件包的元数据。

plaintext
GET <route-prefix>/:package_name

属性	类型	必需	描述
package_name	string	yes	软件包的名称

shell
curl --header "Authorization: Bearer <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/npm/@myscope/my-pkg"

示例响应：

json
1{
2  "name": "@myscope/my-pkg",
3  "versions": {
4    "0.0.2": {
5      "name": "@myscope/my-pkg",
6      "version": "0.0.1",
7      "dist": {
8        "shasum": "93abb605b1110c0e3cca0a5b805e5cb01ac4ca9b",
9        "tarball": "https://gitlab.example.com/api/v4/projects/1/packages/npm/@myscope/my-pkg/-/@myscope/my-pkg-0.0.1.tgz"
10      }
11    }
12  },
13  "dist-tags": {
14    "latest": "0.0.1"
15  }
16}

响应中的 URL 使用请求它们时的相同路由前缀。如果使用实例级别的路由请求它们，返回的 URL 包含 /api/v4/packages/npm。

分发标签#

列出软件包的分发标签。

plaintext
GET <route-prefix>/-/package/:package_name/dist-tags

属性	类型	必需	描述
package_name	string	yes	软件包的名称

shell
curl --header "Authorization: Bearer <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/npm/-/package/@myscope/my-pkg/dist-tags"