是否有Swagger文件的替代UI

Question

我们目前正在使用Postman来构建和测试我们的REST端点。在共享集合时，他们的产品存在一些严重的缺点。基本上，您不能对文档使用源代码控制，因为它会在您导入时更改json文件中的所有guid。

所以我们期待切换到Swagger，Swagger的问题是SwaggerUI不是非常用户友好。我们喜欢Postman让您能够将您的馆藏分解为文件夹，并为您提供一个分屏，您可以在其中运行请求并查看输出。

是否有任何第三方工具为Postman文件提供Swagger样式界面？即易于找到资源的一组方法，并对其进行调用。

Answer 1

Swagger UI为您的API提供实时文档，您始终可以自定义以满足您的需求。这并不困难。来自documentation：

  

自定义

     

您可以选择为您的组织自定义Swagger UI。这是   概述各种目录中的内容：

     

  
• dist：包含可以在服务器或负载上部署的分发   从您当地的机器。
  
• dist/lang：Swagger本地化。
  
• lib：包含Swagger UI所依赖的JavaScript依赖项。
  
• node_modules：Swagger UI使用的节点模块   发展。
  
• src/main/templates：用于处理的句柄模板   渲染Swagger UI。
  
• src/main/html：HTML文件，一些图片和CSS。
  
• src/main/javascript：主要代码。
  

有关其他详细信息，请查看Swagger UI documentation。

主题

• 除了默认的Swagger UI主题外，还要看一下这个Swagger UI responsive theme，受到Auth0 API资源管理器的启发。

• 您也可能想要these themes，它们只是对默认Swagger UI主题的修改。

警告

请注意，Swagger API测试工具。它是 API文档工具。

Answer 2

因此，您对API用户界面有两个要求：

  

  

1. 很容易找到资源的一组方法

  

2. 调用资源方法

  

看来SwaggerUI就是你所需要的。请参阅demo here。

1. 您可以点击Expand Operations并使用浏览器搜索功能按名称查找资源或操作。

2. 您可以提交请求，当必填字段为空时会通知您，请检查资源请求/响应模型。

例如，检查方法GET /store/order/{orderId}。

输入Try it out!后点击orderId按钮，将从用户界面提交请求。