在SwaggerUI中包含客户端SDK使用示例

时间:2018-05-30 12:32:47

标签: api swagger swagger-ui documentation-generation swagger-codegen

我一直在寻找一种工具,可以帮助我解析我的JSON swagger文件(甚至是YAML文件),并根据API文档的this example在我的UI中生成代码示例资源。

我已经尝试过了:

  • codegen(所以我在github repo中有代码示例,但我不知道如何在我的UI上动态获取它)
  • slate,但我正试图继续招摇
  • Widdershins

是否有人知道能够制作此类功能的第三方工具,或者我是否遗漏了codegen或swagger-UI中的某些内容?
或者我应该在我的页面中粗略地编写所有代码示例?

1 个答案:

答案 0 :(得分:0)

终于明白了。我们不能严格地说"包括"动态SDK使用示例到SwaggerUI。 不过,你可以使用多种语言SDK生成ui!它不会看起来一样,但无论如何我都会覆盖css。

在找到Github issue之前,我一直不清楚!您所要做的就是使用编辑器或代码生成html2客户端......

所有内容都在index.html中实现(这有点脏,但仍然可以正常工作!)。