GraphQL怎么生成API DOC

Posted 2023-03-28

参考技术A 我们平时做Restful API开发，有Swagger可以生成API文档，但是用Graphql怎么办呢？我找了下，也没怎么找，发现了些，感觉不大适配Springboot项目，最后发现graphiql就有这个DOC文档，太好了。

打开localhost:port/graphiql 右侧就可以看到

如果你看不到，要在你项目的root.graphql文件里添加如下代码块：

query



mutation

自动生成 GraphQL API 接口

【中文标题】自动生成 GraphQL API 接口

【英文标题】：Autogenerate GraphQL API interface

【发布时间】：2020-01-03 20:24:58

【问题描述】：

我正在使用 Apollo 访问 GraphQL 端点。我在文件中有完整的架构。假设架构如下：

type Widget 
    widgetId: ID!
    name: String


type Query 
    listWidgets: [Widget!]!


type Mutation 
    updateWidget(
        widgetId: ID!
        name: String
    ): Widget!

我想创建一个具有如下接口的 API 对象：

const api = MyApi(endpoint);

const widgets = await api.listWidgets();

const modifiedWidget = await api.updateWidget(
    widgetId: 'myId',
    name: 'My widget',
);

是否有现有的系统可以做到这一点？

【参考方案1】：

到目前为止，我在研究中看到的最强大的东西是 graphql-sequelize，它是 Sequelize 接口的 graphql 数据库后端，是 Node.js 目前更流行的 ORM 之一。