问如何使用Swagger \ OpenAPI记录GraphQL？

EN

GraphQL API通常通过GraphQL服务器本身提供的文档工具进行记录:类型、系统和关于类型和字段的描述。像GraphQL playground这样的工具允许您通过在可视化文档树中单击/搜索或通过类似集成开发环境的功能(autocomplete +工具提示)来浏览应用编程接口文档。这主要是公司公开其公共GraphQL API的方式。一些公司还会暴露类似于swagger的文档(例如Github v4 API docs)。This tool可以为您的应用编程接口创建这样的文档。

另一方面，Swagger为REST API解决了这个问题。因此，Swagger是为不同的生态系统构建的。Swagger在GraphQL中为REST添加了开箱即用的功能。因此，据我所知，任何一方都没有试图创造兼容性。有一些工具可以将Swagger/OpenAPI REST端点公开为GraphQL查询，这在您的过渡期间可能会很有趣。

OpenAPI-to-GraphQL将OpenAPI规范(OAS)或Swagger描述的API转换为GraphQL。

Swagger-to-GraphQL将您现有的Swagger模式转换为可执行的HTTP，其中解析器执行对某些实际端点的GraphQL调用。它允许您轻松地将API迁移到GraphQL，并同时维护REST和GraphQL API。我们的命令行界面工具还允许您以模式定义语言获取GraphQL模式。

不幸的是，截至2021年5月，还没有标准的方法来显示GraphQL端点或从Swagger-UI到Graph_i_QL UI的链接。

因为GraphQL正在与REST竞争，所以大多数GraphQL供应商希望开发人员用GraphQL取代REST，而不仅仅是使用GraphQL进行(只读)查询。

希望当GraphQL更广泛地被采用，它的优点和缺点得到更好的理解时，一个更平衡的观点是使用两者中更好的部分。