GraphQL.IntrospectionModel 0.0.22

graphql-introspection-model

<a href="https://www.buymeacoffee.com/sungam3r" target="_blank"><img src="https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>

GraphQL introspection 模型类型。由 graphql-sdl-exporter 使用。

GraphQL 服务器支持对模式进行 introspection。这个模式使用 GraphQL 本身进行查询，创建了一个强大的工具构建平台。

这是一个“经典”的 introspection 查询示例：

query IntrospectionQuery {
  __schema {
    queryType { name }
    mutationType { name }
    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
            ofType {
              kind
              name
              ofType {
                kind
                name
              }
            }
          }
        }
      }
    }
  }
}

此查询的结果（就像所有其他的 GraphQL 查询一样）是 JSON。您可以直接处理它或将它反序列化到一些数据结构中。此存储库提供了这类数据结构。最顶层类型是 GraphQLResponse。在将 JSON 反序列化为 GraphQLResponse（或以任何其他方式创建 GraphQLSchema）之后，它可以转换成 AST 表示并使用 SDLPrinter 从 GraphQL-Parser NuGet 包打印出来。

introspection 响应的序列化示例：

using System.Text.Json;

string text = ...; // from HTTP introspection response
var response = JsonSerializer.Deserialize<GraphQLResponse>(text, new JsonSerializerOptions
{
    PropertyNameCaseInsensitive = true,
    Converters = { new JsonStringEnumConverter() }
});
var schema = response.Data.__Schema; // note that Data may be null, so check response.Errors 

将 GraphQLSchema 打印到 SDL 的示例：

GraphQLSchema schema = ...;

var converter = new ASTConverter();
var document = converter.ToDocument(schema);
var printer = new SDLPrinter(options);
var sdl = printer.Print(document);

// or use one-line extension method
var sdl = schema.Print();

GraphQL 有自己的语言来编写 GraphQL 模式，SDL - 模式定义语言。SDL 语法简洁直观，同时功能强大，表达性强。SDL 文档的一些示例可以在 graphql-sdl-exporter 项目中找到。

项目中的许多类型实现了 IHasDirectives 接口。该接口用于获取关于元素应用的指令的信息。官方规范中没有描述这种可能性，尽管 讨论 正在进行中，以便扩展规范以添加这个功能。如果服务器支持此功能，graphql-sdl-exporter 可以获取指令信息。

内省查询变体

此仓库提供了 4 种 内省查询 变体

1. 经典 - 上文中提供的 "classic" 内省查询（不暴露应用的指令）。它符合规范的最新版本。

2. ClassicDraft - 与 "classic" 相同，但对输入值进行了弃用处理。有关更多信息，请参阅 PR。它符合预发布（工作草案）版本的规范。

3. 现代 - 修改后的 "classic" 内省查询，其中暴露了应用于模式元素的指令。这需要 GraphQL 服务器支持此功能。请参见 GraphQL.NET 作为此类服务器的示例。

4. ModernDraft - 与 "modern" 相同，但对输入值进行了弃用处理。这是所有可用查询中最先进的。