ApiView 模式
一个将AMF的ld-json模型转化为形式视图模型的库. 窗体视图用于为嵌入在api-request-editor元素中的编辑器提供动力. 该模型应用于构建一个格式视图,用于请求参数如头,查询参数,uri参数或正文等.
版本兼容性
此版本仅与AMF模式版本2(AMF parser QQ 4.0.0)相通.
用于与上一个模型版本的兼容性 3.x.x 版本的组件.
折旧通知
这个 api-view-model-transformer 自定义元素在 AmfHelperMixin 需要一个 HTMLElement 作为基础课。 既然情况并非如此,这个要素正在被改变
进入JS图书馆。 自定义元素仅具有之前可访问的公共属性. 下一次主要发布时, 自定义元素将被删除 .
请用 ApiViewModel 类而不是元素.
使用量
安装
npm install --save @api-components/api-view-model-transformer
示例
import { ApiViewModel } from '@api-components/api-view-model-transformer';
const amf = getAmfFromRamlOrOas();
const headers = extractHeadersForMethod(amf); // or other types.
const worker = new ApiViewModel();
const viewModel = worker.computeViewModel(headers);
此示例使用 getAmfFromRamlOrOas() 函数,用于执行获取AMF json/ld数据的逻辑。 它可以用AMF 解析器存储在文件中或解析. 这个 extractHeadersForMethod() 代表用于提取要转换的属性的逻辑。 它可以是头,查询参数或体型.
折旧实例
<api-view-model-transformer></api-view-model-transformer>
<script>
const amfModel = getAmfFromRamlOrOas();
const processor = document.querySelector('api-view-model-transformer');
processor.amf = amfModel;
processor.shape = extractHeadersForMethod(amfModel);
processor.addEventListener('view-model-changed', (e) => {
console.log(e.detail.value);
});
</script>
ld+json 语境
JSON 计划可能包含 @context 属性。 它可以通过将命名空间代号替换为定义于 @context 关键词 要正确计算AMF值,必须设置完整的AMF模型 amf 属性.
发展
git clone https://github.com/advanced-rest-client/api-view-model-transformer
cd api-view-model-transformer
npm install
本地运行演示
npm start
运行测试
npm test