Lib.rs

为 GraphQL API 生成静态 HTML 文档。

概述

GraphiQL 很棒。同样，像 Altair 和 Insomnia 这样的工具也很棒。但它们可能还不够。

当您想要为存储在共享位置的 GraphQL API 生成文档时，docql 就派上用场了。拥有 HTML 文档允许团队链接到特定的对象和字段，以增强对话，当不在电脑旁时参考文档，并且可以一目了然地查看整个 GraphQL 架构。

示例

• GitHub v4 API： 生成
• GraphQL 的示例星战 API： 生成

使用方法

使用 docql 有两种方式。

npx

最简单的方法是在 npm 注册表中运行 docql。

npx docql -e $API -o ./doc

本地二进制文件

如果您更喜欢本地二进制文件并且可以访问 Rust 的 cargo，则可以使用 cargo install 安装。

cargo install docql
docql -e $API -o ./doc

命令行选项

USAGE:
    docql [OPTIONS] --output <path> <--endpoint <url>|--schema <path>>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -e, --endpoint <url>        The URL of the GraphQL endpoint to document
    -x, --header <header>...    Additional headers when executing the GraphQL introspection query (e.g. `-x
                                "Authorization: Bearer abcdef"`
    -n, --name <name>           The name to give to the schema (used in the title of the page) [default: GraphQL Schema]
    -o, --output <path>         The directory to put the generated documentation
    -s, --schema <path>         The output of a GraphQL introspection query already stored locally