有啥方法可以在 Spring Boot 项目中为 graphql 端点创建 API 文档

Posted

技术标签:

【中文标题】有啥方法可以在 Spring Boot 项目中为 graphql 端点创建 API 文档【英文标题】:Is there any way to create API documentation for graphql end points in a spring boot project有什么方法可以在 Spring Boot 项目中为 graphql 端点创建 API 文档 【发布时间】:2020-12-22 15:28:17 【问题描述】:

我有一个 springboot 微服务项目,我正在使用 graphql。对于 REST api 端点,我知道我们可以使用 swagger 等进行记录。Graphiql 还提供动态文档,但有没有其他方法可以为不太了解 graphql 或 Graphiql 工作原理的客户创建 API 文档。

【问题讨论】:

我也有同样的问题。 GraphQL-spqr 自动生成一个 graphql schema。我仍在寻找一种方法来访问/读取/查看这个自动生成的模式。 GraphiQL 没有显示。 【参考方案1】:

aaah 这可能会有所帮助:您可以通过编程方式获取(并打印)生成的架构:

How to get the generated scheme file .graphqls using SPQR?

【讨论】:

以上是关于有啥方法可以在 Spring Boot 项目中为 graphql 端点创建 API 文档的主要内容,如果未能解决你的问题,请参考以下文章

如何在 IntelliJ IDEA 中为 Spring Boot 项目构建 jar 工件

在 pom.xml 中为 Kotlin 中的 Spring Boot 项目指定 Main 类

你可以在 Spring Boot 中为多个模型设置一个控制器吗?

有啥方法可以通过 Spring Boot JPA Repository 接收 List<LocalDate>

spring boot整合swagger有啥好处

在 Spring Boot 项目中使用 HikariCP 和 Hibernate 的更好方法