dotnet-sdlexport 0.0.24

graphql-sdl-exporter

<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>

.NET Core 全局工具，用于从 URL 或可执行文件生成 SDL。

安装

您可以通过NuGet安装最新版本。

> dotnet tool install -g dotnet-sdlexport

命令行选项

只需输入

> sdlexport

即可查看所有可用选项。有关更多信息，请参阅CommandLineOptions。

这是什么？

此工具从提供的 URL 或可执行 ASP.NET Core 程集的路径生成文本 SDL（模式定义语言）文件。在 URL 情况下，工具立即向该 URL 发送 introspection 请求。如果指定文件路径作为源，则工具会启动临时进程，并在收到 introspection 响应后停止它。在工具启动其已知 URL 上的进程时，它才能发送请求。此参数通过 --url 命令行选项传递，默认值为 https://127.0.0.1:8088。然后将此参数作为 --server.urls 命令行选项传递给启动的进程。

请注意，使用此方法时，服务不需要（尽管可能）在启动时执行任何辅助工作，例如联系外部系统、数据库等，因为这可能会减慢获取模式的过程。该工具将API_ONLY_RESTRICTED_ENVIRONMENT 命令行键传递给正在启动的过程。通过此键的存在，可以禁用执行不需要获取模式的代码。

public static Task Main(string[] args) => CreateBuilder(args)
    .Build()
    .RunAsync();

private static IWebHostBuilder CreateBuilder(string[] args)
    => args.Contains("API_ONLY_RESTRICTED_ENVIRONMENT")
    ? WebHost.CreateDefaultBuilder<StartupApiOnly>(args)
    : WebHost.CreateDefaultBuilder<Startup>(args);

为什么需要它？

与原始的JSON自省响应相比，SDL与SDL更容易使用。SDL更容易阅读和理解。与原始的JSON相比，SDL也更为紧凑——在这种情况下，更容易跟踪更改。SDL文件，就像任何代码文件一样，可以作为版本控制系统中的工件存储，并作为公共API提供服务。

实验性功能

如果服务器支持此功能，工具可以获取指令信息。如果服务器不支持指令返回（在这种情况下，服务器返回请求验证错误），则工具使用经典的自省请求。官方规范[官方规范]没有描述这种可能性，尽管讨论正在进行中，以扩展规范以添加此功能。

用法

1. GitHub GraphQL API v4 [Generated SDL]

sdlexport --source https://api.github.com/graphql --auth bearer|<YOUR_TOKEN> --out samples/github.graphql

2. SWAPI - 星际大战API的包装GraphQL模式和服务器。 [Generated SDL]

sdlexport --source https://swapi-graphql.netlify.com/.netlify/functions/index --out samples/swapi.graphql

3. HIVDB - 一个精选数据库，用于表示、存储和分析HIV药物耐药性数据。 [Generated SDL]

sdlexport --source https://hivdb.stanford.edu/graphql --out samples/hivdb.graphql

4. Countries - 基于a href="https://annexare.github.io/Countries/" rel="noopener noreferrer nofollow">Countries List。 [Generated SDL]

sdlexport --source https://countries.trevorblades.com --out samples/countries.graphql

5. 您可以直接从发布的ASP.NET Core应用程序中导出模式

> sdlexport --source C:\MyWebHost.dll --out samples/myschema.graphql

查看完整选项列表

> sdlexport

另请参阅

• GraphQL的逐步介绍
• 类型系统和SDL规范
• 自省规范
• GraphQL for .NET
• GraphQL自省模型的类型