使用GraphQL生成API文档

GraphiQL 是一个非常流行的交互式开发环境（IDE），专门用于浏览、编写和测试 GraphQL 查询。它不仅可以帮助你查询 API，还可以自动生成文档。以下是如何使用 GraphiQL 的具体步骤：

仓库地址：https://github.com/anvilco/spectaql?tab=readme-ov-file#yaml-options

1. GraphiQL 安装与配置

方式：本地或全局安装 GraphiQL

如果你的 GraphQL API 服务器没有内置 GraphiQL，你可以使用独立的 GraphiQL 框架或包。

全局安装 GraphiQL
如果你想在本地环境使用 GraphiQL，你可以通过 npm 或 yarn 安装：
如果下载不成功可以使用淘宝镜像源
```
npm install -g graphiql
```
通过 npm 或 Yarn 安装为开发依赖
你也可以将 GraphiQL 作为开发依赖安装到项目中：
```
npm install graphiql
```
生成您的文档！
```
npx spectaql config.yml
```
运行此命令你需要一份config.yml文件。具体使用参考https://github.com/anvilco/spectaql?tab=readme-ov-file#yaml-options

2. 使用JSON格式生成文档

生成或导出 schema 文件

自动生成 schema
如果你使用的是 Java 类和注解方式定义的 GraphQL API（使用 @GraphQLQuery 等注解），GraphQL schema 通常在运行时生成。你可以使用 Spring Boot 启动后访问 GraphQL endpoint 来手动导出 schema。

访问 GraphQL Endpoint：在应用运行时，GraphQL API 通常暴露在 /graphql 路径下。你可以通过 introspection 查询导出完整的 GraphQL schema。

下面是一个 introspection 查询的示例，它可以帮助你获取 schema：这个查询可根据文档需要动态调整。查询http://127.0.0.1:8091/pamirs/graphql。

query IntrospectionQuery {
 __schema {
   queryType { ...FullType }
   mutationType { ...FullType }
   subscriptionType { name }
   types {
     ...FullType
   }
   directives {
     name
     description
     locations
     args {
       ...InputValue
     }
   }
 }
}

fragment FullType on __Type {
 kind
 name
 description
 fields(includeDeprecated: true) {
   name
   description
   args {
     ...InputValue
   }
   type {
     ...TypeRef
   }
   isDeprecated
   deprecationReason
 }
 inputFields {
   ...InputValue
 }
 interfaces {
   ...TypeRef
 }
 enumValues(includeDeprecated: true) {
   name
   description
   isDeprecated
   deprecationReason
 }
 possibleTypes {
   ...TypeRef
 }
}

fragment InputValue on __InputValue {
 name
 description
 type { ...TypeRef }
 defaultValue
}

fragment TypeRef on __Type {
 kind
 name
 ofType {
   kind
   name
   ofType {
     kind
     name
     ofType {
       kind
       name
       ofType {
         kind
         name
         ofType {
           kind
           name
         }
       }
     }
   }
 }
}

你可以将这个查询放在 GraphiQL（开发工具）或者 Postman 等工具中，发送请求到 /graphql，这样可以获得完整的 schema。

将请求的响应保存为JSON文件，在config.yml中配置。配置参考：https://github.com/anvilco/spectaql/blob/main/config-example.yml

spectaql:
  # Optional path to the target build directory.
  # Set to null to not write the output to the filesystem, making it only available via the API (default: public)
  #
  # Default: public
  targetDir: /Users/mmy/Desktop
  themeDir: /Users/mmy/Desktop

introspection:
  # File containing a GraphQL Schema Definition written in SDL.
  # Can also pass an array of paths (or glob supported by @graphql-tools/load-files)
  # like so:
  # schemaFile:
  #   - path/to/schema/part1.gql
  #   - path/to/schema/part2.gql
#  schemaFile: /Users/mmy/Desktop/schema2.graphql

  # File containing Introspection Query response in JS module export, or JSON format
  introspectionFile: /Users/mmy/Documents/response2.json
#
  # URL of the GraphQL endpoint to hit if you want to generate the documentation based on live Introspection Query results
  # NOTE: If not using introspection.url OR servers[], you need to provide x-url below
#  url: 'http://127.0.0.1:8091/pamirs/graphql'

extensions:
  # Utilize the 'graphql-scalars' library when generating examples for scalars it supports that
  # do not have an example already set via some other method. Usually this is a good
  # thing to have on, but it is possible to turn it off.
  # Default: true
  graphqlScalarExamples: true

servers:
  - url: http://127.0.0.1:8091/pamirs/base

运行命令npx spectaql config.yml就可以得到一份html的API文档啦！