GraphiQL.NET 项目教程

1. 项目目录结构及介绍

GraphiQL.NET 是一个用于 ASP.NET Core 的 GraphiQL 中间件项目。以下是项目的目录结构及其介绍：

graphiql-dotnet/
├── .github/
│   └── workflows/
├── assets/
├── src/
│   └── GraphiQl/
├── tests/
├── .gitignore
├── GraphiQl.sln
├── LICENSE
├── README.md
└── package.sh

目录结构说明

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• assets/: 存放项目相关的静态资源文件。
• src/GraphiQl/: 项目的源代码目录，包含主要的代码实现。
• tests/: 存放项目的测试代码。
• .gitignore: Git 忽略文件配置。
• GraphiQl.sln: 项目的解决方案文件，用于 Visual Studio 或其他 IDE 打开项目。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• package.sh: 可能是一个用于打包或发布项目的脚本文件。

2. 项目启动文件介绍

项目的启动文件通常位于 src/GraphiQl/ 目录下，主要包括 Startup.cs 文件。以下是 Startup.cs 文件的介绍：

// Startup.cs
public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // 配置服务
        services.AddGraphiQl(options =>
        {
            options.GraphiQlPath = "/graphiql-ui";
            options.GraphQlApiPath = "/graphql";
        });
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        // 使用 GraphiQL 中间件
        app.UseGraphiQl();

        app.UseRouting();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
    }
}

启动文件说明

• ConfigureServices 方法: 用于配置应用程序的服务。在这里，我们使用 AddGraphiQl 方法来配置 GraphiQL 的路径和 API 路径。
• Configure 方法: 用于配置 HTTP 请求管道。在这里，我们使用 UseGraphiQl 方法来启用 GraphiQL 中间件，并配置路由和其他中间件。

3. 项目的配置文件介绍

项目的配置文件通常包括 appsettings.json 和 appsettings.Development.json 等文件。以下是一个示例配置文件的内容：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "GraphiQl": {
    "GraphiQlPath": "/graphiql-ui",
    "GraphQlApiPath": "/graphql"
  }
}

配置文件说明

• Logging: 配置日志记录的级别。
• AllowedHosts: 配置允许访问的主机。
• GraphiQl: 配置 GraphiQL 的路径和 GraphQL API 的路径。

通过这些配置，可以灵活地调整 GraphiQL 和 GraphQL API 的路径，以适应不同的部署环境。