从 Swagger API 规范生成 Angular2 表单

Posted

技术标签:

【中文标题】从 Swagger API 规范生成 Angular2 表单【英文标题】:Generate Angular2 forms from Swagger API specification 【发布时间】:2017-07-08 22:34:43 【问题描述】:

我正在寻找一种从 Swagger API 定义文件生成一组 Angular2 表单模板的方法。我想要一个可以让我测试我的 POST/PUT 请求的结果,甚至可以在我的应用程序中使用它。

经过一番研究,我发现了这个以 JSON 模式作为输入的 Angular2 表单库:https://github.com/makinacorpus/angular2-schema-form

因此,如果您知道 Swagger -> JSON Schema 转换器也可以使用。

干杯!

【问题讨论】:

【参考方案1】:

因此,如果您知道 Swagger -> JSON Schema 转换器,它将起作用 也是。

Swagger 2.0 支持 JSON 模式草案 4 的子集。这就是 swagger 的 Schema 对象。来自docs:

以下属性直接取自 JSON Schema 定义并遵循相同的规范:

$ref - 作为 JSON 参考 格式(有关详细信息,请参阅数据类型格式) 标题 说明(GFM 语法可用于富文本表示) 默认(与 JSON Schema 不同,该值必须符合为 Schema Object 定义的类型) multipleOf ...

以下属性取自 JSON Schema 定义,但 他们的定义已根据 Swagger 规范进行了调整。

项目 全部 属性 其他属性

从大张旗鼓中手动提取模式应该是一个相当简单的练习,但我不知道有任何自动化工具可以做到这一点。我认为某些 JSON 模式属性已被 swagger 修改的事实可能会使自动转换在某些情况下出现问题。

【讨论】:

以上是关于从 Swagger API 规范生成 Angular2 表单的主要内容,如果未能解决你的问题,请参考以下文章

从 OpenAPI 规范生成 JSDoc

1 API接口文档规范Swagger3 简介

1 API接口文档规范Swagger3 简介

swagger生成接口文档和map类型参数解析

Dubbo 版 Swagger 来啦!Dubbo-Api-Docs 发布

如何从 WCF-REST API 服务创建 Swagger 规范