# @atlassianlabs/jql-editor-autocomplete-rest 中文文档

规范地址：https://npmcn.com/package/%40atlassianlabs/jql-editor-autocomplete-rest/

版本：1\.1\.2
npm 元数据更新时间：2026-06-24T07:25:58.376Z
中文译文更新时间：2026-11-07T03:29:48.968Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40atlassianlabs/jql-editor-autocomplete-rest
原文对照：https://npmcn.com/package/%40atlassianlabs/jql-editor-autocomplete-rest/?lang=original
项目主页：https://bitbucket.org/atlassian/atlassian-frontend#readme
源码仓库：https://bitbucket.org/atlassian/atlassian-frontend

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

- 包体积（解压后）：469 kB，98 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- peer 依赖：react ^16\.8\.0
- 首次发布：2021-12-10T01:09:35.671Z
- 最新版本发布：2023-07-12T04:56:07.103Z
- 近 30 天下载量：2118（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

JQL 编辑器自动完成 REST API 集成.

## 安装

```sh
npm install @atlassianlabs/jql-editor-autocomplete-rest
```

也可以使用：`pnpm add @atlassianlabs/jql-editor-autocomplete-rest`、`yarn add @atlassianlabs/jql-editor-autocomplete-rest`、`bun add @atlassianlabs/jql-editor-autocomplete-rest`

## README

# JQL 编辑器自动完成 REST

[![Atlassian license](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](https://npmcn.com/package/%40atlassianlabs/jql-editor-autocomplete-rest/LICENSE)

此软件包将获取 JQL 编辑器的自动完整数据所需的调用内容包裹起来, 并提供简单的钩子给 代表团 [Jira Cloud REST API的(英语:Jira Cloud rest API) 互联网电影数据库(IMDb)上"Jira Cloud REST"的资料(英文)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql/)。 。 。 .

我们要求这些可配置的钩子 让消费者根据自己的应用环境 定义自己的取取库, 例如:Jira,Connect,Forge等.

## 使用量

自动完整提供者的最低配置如下:

```typescript
import { useAutocompleteProvider } from '@atlassianlabs/jql-editor-autocomplete-rest';

const getInitialData = async (url: string) => {
  const response = await fetch(url, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ includeCollapsedFields: true })
  });
  const data = response.json();
  
  return {
    jqlFields: data.visibleFieldNames,
    jqlFunctions: data.visibleFunctionNames,
  };
};

const getSuggestions = async (url: string) => {
  const response = await fetch(url);
  return response.json();
};

const useMyAutocompleteProvider = () => {
  return useAutocompleteProvider('my-app', getInitialData, getSuggestions);
};
```

## 安装

```sh
yarn add @atlassianlabs/jql-editor-autocomplete-rest
```

## 支助

对于在Atlassian以外的开发者寻求帮助或报告问题, [请在社区论坛发表文章](https://community.developer.atlassian.com/c/atlassian-ecosystem-design)。 。 。 . 我们将监测这些论坛,并重新将专题分配给适当的维护者.

## 许可证

版权(c) 2021-2022 阿特拉斯人等. Apache 2.0 许可证,见 [自由主义](https://npmcn.com/package/%40atlassianlabs/jql-editor-autocomplete-rest/LICENSE) 文档.

## 常见问题

### @atlassianlabs/jql-editor-autocomplete-rest 是什么？

JQL 编辑器自动完成 REST API 集成\.

### 如何安装 @atlassianlabs/jql-editor-autocomplete-rest？

在项目目录运行 npm install @atlassianlabs/jql-editor-autocomplete-rest，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^16\.8\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @atlassianlabs/jql-editor-autocomplete-rest 支持 TypeScript 吗？

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

### @atlassianlabs/jql-editor-autocomplete-rest 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @atlassianlabs/jql-editor-autocomplete-rest 可以商用吗？

@atlassianlabs/jql-editor-autocomplete-rest 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @atlassianlabs/jql-editor-autocomplete-rest 的下载量有多少？

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

### @atlassianlabs/jql-editor-autocomplete-rest 还在维护吗？

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