API 元素: OpenAPI 3 解析器

当前状况

API 元素 打开API 3 Parser 处于初期阶段,没有提供 完全支持 OpenAPI. 解析器会发出不支持的警告 函数。 你可以参考 状态文档 以检查当前状态 为每个功能提供支持.

使用量

安装 Fury 和 Open API 3 适配器,包括迷你.

$ npm install @apielements/openapi3-parser

const { Fury } = require('fury');
const openapi3Adapter = require('@apielements/openapi3-parser');

// Add the OpenAPI 3 Adapter to Fury
fury.use(openapi3Adapter);

fury.parse({source: '... your OpenAPI 3 Document ...'}, (err, parseResult) => {
  console.log(parseResult.api.title);
});

读取 API 要素联合材料:分析 结果 用于了解分析结果类型.

捐款

如果您正在尝试整合 OpenAPI 3 适配器或使用一个产品 使用 API 元素 然后我们欢迎您对适配器的任何反馈 在我们的问题跟踪器。 您可以在不支持的情况下找到打开的问题跟踪 功能,将支持下一个步骤。 对于 1.0.0 里程碑 我们 将只专注于 OpenAPI 3 的初始支持 3个特征,需要一些设计思考和今后发布 API 密码 要件。 。 。 .

我们把一些问题贴上了 "不错的第一期" 表明他们 对于第一次贡献者来说,这些任务比较简单。 你们可以找到 解析器如何运作的信息和我们 捐款 文档。 。 。 .

一定要检查一个 问题并非由他人指定来防止浪费精力.