# @abapify/adt-contracts 中文文档

规范地址：https://npmcn.com/package/%40abapify/adt-contracts/

版本：0\.4\.34
npm 元数据更新时间：2026-11-02T23:19:04.391Z
中文译文更新时间：2026-11-06T02:43:52.394Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40abapify/adt-contracts
原文对照：https://npmcn.com/package/%40abapify/adt-contracts/?lang=original
项目主页：https://github.com/abapify/adt-cli/tree/main/packages/adt-contracts#readme
源码仓库：https://github.com/abapify/adt-cli

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2.1 MB，16 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-04-20T21:10:59.353Z
- 最新版本发布：2026-11-02T23:19:04.044Z
- 近 30 天下载量：6171（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：31（近 12 个月 31 个）

## 中文简介

SAP APT REST API合同,使用 speci + ts-xsd

## 安装

```sh
npm install @abapify/adt-contracts
```

也可以使用：`pnpm add @abapify/adt-contracts`、`yarn add @abapify/adt-contracts`、`bun add @abapify/adt-contracts`

## README

# @abapify/adt合同

[![version](https://img.shields.io/github/package-json/v/abapify/adt-cli?filename=packages/adt-contracts/package.json)](https://github.com/abapify/adt-cli/pkgs/npm/%40abapify%2Fadt-contracts)

**SAP APT REST API合同** - 使用 `speci` + 键 `ts-xsd` 计划.

部分 [生化单体](https://npmcn.com/package/README.md)。 。 。 .

## 这是什么?

这个包是 **合同层** 介于 `adt-client` 财务报告和审定财务报表 `adt-schemas`它为SAP ADT(ABAP开发工具)端点提供了声明性REST API合同.

```
┌─────────────────────────────────────────────────────────────────┐
│                      adt-client                               │
│              (HTTP Client + Request Execution)                   │
└─────────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────────┐
│                      adt-contracts (this package)                │
│         (REST API Contracts using speci + ts-xsd)                │
└─────────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────────┐
│                     adt-schemas                              │
│        (TypeScript schemas from SAP XSD definitions)             │
└─────────────────────────────────────────────────────────────────┘
```

合同是界定下列内容的纯数据结构:

-   **端点 URL** - 返回路径
-   **HTTP 方法** - 得到,邮递,PUT,德利特
-   **请求/响应计划** - 使用 `ts-xsd` 根据 SAP XSD 定义生成
-   **内容 - 类型** - SAP供应商特有的媒体类型

## 安装

```bash
bun add adt-contracts
```

## 使用量

### 带有 speci 客户端

```typescript
import { adtContract } from 'adt-contracts';
import { createClient } from 'speci/rest';

const client = createClient(adtContract, {
  baseUrl: 'https://sap-server.example.com/sap/bc/adt',
  adapter: myAdapter,
});

// Full type inference from XSD schemas!
const transport = await client.cts.getTransportRequests();
const classInfo = await client.oo.getClass('ZCL_MY_CLASS');
```

### 个人合同

```typescript
import { ctsContract, atcContract, ooContract } from 'adt-contracts';

// Use specific contracts
const cts = createClient(ctsContract, config);
const atc = createClient(atcContract, config);
```

## 现有合同

| 合同 | 说明 |
| --- | --- |
| `coreContract` | 核心 ADT 对象操作 |
| `ctsContract` | 变革和运输系统 |
| `atcContract` | ABAP 测试舱 |
| `ooContract` | 面向对象(类、接口) |

## 建筑

```
adt-contracts (this package)
    ├── speci contracts (endpoint definitions)
    └── adt-schemas (ts-xsd schemas)
            └── ts-xsd (XSD → TypeScript)
```

**合同是纯数据** 没有HTTP客户端 没有商业逻辑 与任意 `speci`\- 兼容的适配器.

## 添加新合同

1.  确保在 `adt-schemas`
2.  创建合同文件于 `src/adt/<feature>/index.ts`
3.  使用 `adtHttp.get/post/put/delete`
4.  导出自 `src/adt/index.ts`

```typescript
import { adtHttp } from '../../base';
import { mySchema } from 'adt-schemas';

export const myContract = {
  getResource: (id: string) =>
    adtHttp.get(`/my/endpoint/${id}`, {
      responses: { 200: mySchema },
      headers: { Accept: 'application/vnd.sap.adt.my.v1+xml' },
    }),
};
```

## 许可证

麻省理工学院

## 常见问题

### @abapify/adt-contracts 是什么？

SAP APT REST API合同,使用 speci \+ ts-xsd

### 如何安装 @abapify/adt-contracts？

在项目目录运行 npm install @abapify/adt-contracts，或使用 pnpm add / yarn add / bun add。

### @abapify/adt-contracts 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @abapify/adt-contracts 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @abapify/adt-contracts 可以商用吗？

@abapify/adt-contracts 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @abapify/adt-contracts 的下载量有多少？

根据 npm 官方下载统计，@abapify/adt-contracts 在 2026/10/05 – 2026/11/03 这 30 天内被下载 6,171 次，日均约 206 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @abapify/adt-contracts 还在维护吗？

最新版本 0\.4\.34 发布于 2026/11/03（3 天前）；至今共发布 31 个版本，其中过去 12 个月发布了 31 个；首次发布于 2026/04/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。