GraphiQL.NET 使用教程

1. 项目介绍

GraphiQL.NET 是一个为 ASP.NET Core 应用程序提供 GraphiQL 中间件的开源项目。GraphiQL 是一个交互式的 GraphQL 查询工具，允许开发者通过浏览器界面直接与 GraphQL API 进行交互。GraphiQL.NET 将 GraphiQL 集成到 ASP.NET Core 应用程序中，简化了前端依赖的管理，并提供了对路由和认证的控制。

2. 项目快速启动

安装

首先，通过 NuGet 安装 GraphiQL.NET：

Install-Package graphiql

或者使用 .NET Core CLI：

dotnet add package graphiql

配置

在 Startup.cs 文件中配置 GraphiQL.NET 中间件：

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
    // 添加 GraphiQL 中间件，默认路径为 /graphql
    app.UseGraphiQl();

    // 添加 MVC 中间件
    app.UseMvc();
}

启动应用

启动 ASP.NET Core 应用程序后，访问 /graphql 路径即可看到 GraphiQL 界面。

3. 应用案例和最佳实践

自定义路由

GraphiQL.NET 允许你自定义 GraphiQL 的路由。例如，将 GraphiQL 界面放在 /graphiql 路径下：

app.UseGraphiQl("/graphiql");

配置 GraphQL API 地址

如果你的 GraphQL API 不在默认路径下，可以通过以下方式配置：

app.UseGraphiQl("/graphiql", "/v1/yourapi");

这样，GraphiQL 界面将通过 /graphiql 路径访问，而 GraphQL API 则通过 /v1/yourapi 路径访问。

通过 IServiceCollection 配置

你还可以通过 IServiceCollection 进行配置：

public void ConfigureServices(IServiceCollection services)
{
    services.AddGraphiQl(x =>
    {
        x.GraphiQlPath = "/graphiql-ui";
        x.GraphQlApiPath = "graphql";
    });
}

4. 典型生态项目

GraphQL.NET

GraphQL.NET 是一个用于构建 GraphQL 服务器的 .NET 库。它与 GraphiQL.NET 配合使用，可以快速搭建一个功能完善的 GraphQL API 服务器。

HotChocolate

HotChocolate 是另一个流行的 .NET GraphQL 服务器库，支持多种数据源和强大的查询能力。结合 GraphiQL.NET，可以为开发者提供一个强大的开发和调试环境。

通过以上步骤，你可以快速上手并使用 GraphiQL.NET 中间件，为你的 ASP.NET Core 应用程序提供一个交互式的 GraphQL 查询界面。