被否决
这一部分正在贬值。 代码基础已移动到 api 文档 模块。 此模块将在 第37号共和国文件 合并.
测试和逻辑被迁移到 @api-components/api-schema 模块.
从AMF模型中生成实例.
版本兼容性
此版本仅与AMF模式版本2(AMF parser QQ 4.0.0)相通.
用于与上一个模型版本的兼容性 3.x.x 版本的组件.
断开
这个 api-example-generator 自定义元素已贬值,并将随下一份主要发布而去除.
当 AmfelperMixin 需要 HTMLElement 构建器时,该元素被创建 。 现在没有这种要求,而这种要求不是联合来文图书馆.
使用量
安装
npm install --save @api-components/api-example-generator
API 密码
见 src/例增生器 为大众API.
import { ExampleGenerator } '@api-components/api-example-generator';
const gen = new ExampleGenerator(amfModel);
const examples = new gen.computeExamples(schema, 'application/json', {...});
在 html 文件内
这是被贬损的
<html>
<head>
<script type="module">
import '@api-components/api-example-generator/api-example-generator.js';
</script>
</head>
<body>
<api-example-generator></api-example-generator>
</body>
</html>
在升元素中
这是被贬损的
import { LitElement, html } from 'lit-element';
import '@api-components/api-example-generator/api-example-generator.js';
class SampleElement extends LitElement {
render() {
return html`
<api-example-generator .amf="${this.model}"></api-example-generator>
`;
}
}
customElements.define('sample-element', SampleElement);
列出有效载荷的介质类型
使用 listMedia() 接受有效载荷清单或单一有效载荷定义.
有效载荷示例
使用 generatePayloadsExamples() 生成有效载荷示例清单.
提供第二个参数,这是一个媒体类型,应当用来生成一个实例.
目前仅 application/json 财务报告和审定财务报表 application/xml 被支持.
请随意发送一个PR来添加对更多媒体类型的支持.
任意AMF 形状的示例
这个 computeExamples() 方法试图查找任意AMF形状的示例属性.
如有可能(否) rawOnly 或者说 noAuto 选项设置)然后生成示例
取决于通过的对象.
发展
git clone https://github.com/advanced-rest-client/api-example-generator
cd api-example-generator
npm install
本地运行演示
npm start
运行测试
npm test