Documentation 使用OpenAPI规范的API文档,在中心位置使用多个规范

Documentation 使用OpenAPI规范的API文档,在中心位置使用多个规范,documentation,openapi,api-doc,redoc,Documentation,Openapi,Api Doc,Redoc,我们有很多微服务公开它们的API,我们有一个API优先的方法。每个服务都有自己的OpenApi3.0规范文件,大部分是yaml或json格式的git repo文件 然而,与其他公司一样,我的团队和其他内部团队在发现API及其相关文档方面也面临着困难。我想建立一个中心的地方,可以呈现所有的API规范,使事情容易发现。可能与条目或推特文档标准相符合。 到目前为止,我已经找到了一些实现这一目标的方法: 使用React框架分别呈现每个规范的Redoc组件。使其具有可扩展性,但跨服务搜索可能很困难 使用

我们有很多微服务公开它们的API,我们有一个API优先的方法。每个服务都有自己的OpenApi3.0规范文件,大部分是yaml或json格式的git repo文件

然而,与其他公司一样,我的团队和其他内部团队在发现API及其相关文档方面也面临着困难。我想建立一个中心的地方,可以呈现所有的API规范,使事情容易发现。可能与条目或推特文档标准相符合。 到目前为止,我已经找到了一些实现这一目标的方法:

  • 使用React框架分别呈现每个规范的Redoc组件。使其具有可扩展性,但跨服务搜索可能很困难

  • 使用一些预先存在的工具合并所有api规范,并将其转换为MarkDown以在Slate中显示,或者将Docusauras与React Redoc stuff一起使用。使用和widdershins与slate合并。在一个拥有多个API的公司中,我认为使用这种方法进行扩展将是一个有趣的挑战

  • 我不想依赖于招摇过市,因为它将我与某些特定的东西联系在一起。同样,我正在寻找许可证允许商业使用的开源产品

    我很想得到一些建议/经验,或者如果存在类似的东西,我可以避免重新发明轮子