Ama OpenAPI 重播插件

[尖叫声] 实验:此包可提前访问,最终版本将发布于v15.

用于管理 OpenAPI 依赖性和掩码操作的 Redocly CLI 插件 @ ama- openapi/ 核心。 。 。 .

概览

这个插件扩展了Redocly CLI的功能,可以处理OpenAPI依赖设置和内容遮盖. 它发挥杠杆作用,利用由难民署提供的核心依赖管理系统 @ama-openapi/core 将 OpenAPI 依赖性自动解析和整合到您的规格中.

特征

• 扶养管理: 自动解决和管理 OpenAPI 依赖性
• 内容遮掩: 应用遮盖规则来隐藏或转换OpenAPI规格中的敏感信息
• 重新整合: 与 Redocly CLI 工具链无缝集成
• 可配置: 支持依赖解析和遮掩规则的自定义配置

安装

npm install @ama-openapi/redocly-plugin

使用量

基本配置

将插件添加到您的 Redocly 配置文件( R).redocly.yaml 或者说 redocly.yaml:

plugins:
  - '@ama-openapi/redocly-plugin'

依赖性检索

插件检索您定义的依赖性 OpenAPI 配置数字 :

// in the package.json file
{
  "name": "@my/specification",
  "dependencies": {
    "@specification/pet-store": "latest"
  }
}

# in the openapi.manifest.yaml
models:
  "@specification/pet-store": "models/pet.v1.yaml"

# in your specification
openapi: 3.0.0
info:
  title: My API
  version: 1.0.0

content:
  application/json:
    schema:
      type: object
        properties:
          data:
            $ref: './specification/pet-store/models/pet.v1.yaml'

[TIP] 查找关于一揽子管理战略的文件 节点软件包管理器。 。 。 .
寻找一份完整文件,说明《关于 OpenAPI 配置。 。 。 .

面具配置

有关掩盖特定资料的完整文件载于 OpenAPI 面具配置。 。 。 .
一个简单的例子是:

# in the openapi.manifest.yaml
models:
  "@specification/pet-store":
    - path: "models/pet.v1.yaml"
      transform:
        - fileRename: "my-$1"
          mask:
            properties:
              exampleField:

可用的插件配置

由于插件必须在 Redocly 进程初始化时执行,所以插件的配置应通过 环境变量。 。 。 .

支持以下环境变量:

额外的自定义装饰器

插件提供了额外 重置装饰器 可以选择和配置在 重置配置。 。 。 .

现有装饰品的全部清单及其备选方案载于 专门文件。 。 。 .

一体化

这个再多功能插件旨在与下列工具相配合:

• @ ama- openapi/ 核心: 核心依赖管理功能
• @ama-openapi/ cli (英语): 命令手动取回依赖关系
• @ ama- openapi/ 创建: 项目脚手架工具