REST API文档平台

时间:2019-01-04 15:48:03

标签: rest swagger documentation

我和我的团队一直在编写一些REST API,我们希望为我们的潜在客户创建一些高质量的精致API文档。我正在寻找可以支持以下内容的平台:

  • 允许提供有关API的背景/周围信息
  • 允许使用案例/用户案例来描述在不同情况下对API的调用的逻辑过程
  • 允许嵌入图像或视频以进行示例和演示。
  • 支持Open API 2.0或3.0的技术文档
  • 允许出于品牌目的定制样式

我们一直在为我们的API创建和维护Swagger 2.0文档,因此我们已经介绍了这些内容。我们一直在内部使用Swagger UI,供前端开发人员使用。这对于技术文档来说非常有用,但是我觉得Swagger不支持很多我也想包括的背景,用户故事文档(也许我只是不太了解规范)。

我研究了其他一些基于Swagger / Open API规范的API文档平台。我发现的问题是,其中许多都是完全基于规范。这意味着所有介绍/用户故事描述都将被压入markdown的“ info”或“ description”字段中。我想可以做到这一点,但对我来说有点荒谬。

最好,我可以从Swagger文件中导入文档的技术方面,并可以通过平台管理任何其他内容。任何建议将不胜感激。

0 个答案:

没有答案