简介
graphql-cli-generate-schema 是一个 NPM 包,可以用来从现有 GraphQL 服务器中生成 SCHEMA。
安装
你可以使用以下命令安装 graphql-cli-generate-schema
:
npm install -g graphql-cli-generate-schema
使用方法
常规用法
要生成 SCHEMA,请在控制台输入以下命令:
graphql-cli generate-schema --header "Authorization: Bearer <token>" https://{graphql-endpoint}
这会在控制台中返回 SCHEMA。
指定文件输出
要将 SCHEMA 写入到文件中,请使用 -o
或 --output
参数。
graphql-cli generate-schema --output schema.graphql https://{graphql-endpoint}
此命令将生成 SCHEMA 并将其写入文件“schema.graphql”中。
从本地文件中生成 SCHEMA
如果你想从本地文件中生成 SCHEMA,请使用 -s
或 --schema
参数。
graphql-cli generate-schema --schema schema.graphql --header "Authorization: Bearer <token>"
生成 TypeScript 类型定义
要生成 TypeScript 类型定义,请使用 -t
或 --typescript
参数。
graphql-cli generate-schema -t https://{graphql-endpoint}
这会告诉 graphql-cli-generate-schema
生成 TypeScript 类型定义。输出将类似于以下内容:
-- -------------------- ---- ------- ------ --------- ------------- - ------ - ------- ----- -- ----- - --- ------- --------- ------- ------ ------- -- -
示例
以下是从现有 GraphQL 服务器生成 SCHEMA 的完整示例:
graphql-cli generate-schema --header "Authorization: Bearer <token>" https://{graphql-endpoint}
输出:
-- -------------------- ---- ------- ------ - ------ ----- - ---- ----- - ------- ----- -------- ----- ---- ----------------- -------- ----- --------- ---------- ---------------------------------------------- ------ -------- - --------- ---- - --- --- - ---- ---------- ---------- ---- - --- --- ----- ------- -------------- ------- ------ ---------------- ---- ---- ------- ------ --- ------ ------ ----- --- ------- ------ ------- --------- ------- ------------- --------- ------------ -- ---------------- ------------- ------ --- ------ ------ ----- --- ------- ------ ------- ------------------- ------- --------- ------------ ------ ------------ ------ --------- ------------------------------- -- ---------------------- - ---- --------------- - --- --- ------ ------- ---- ---- ------------- ------ --- ------ ------ ----- --- ------- ------ ------- ------- -------- --------------- -------- ----------------- ------------- ----------------------- ------------------ ----------------------- --------- ------- ------ ------ ----------- -------------------- -- --------------------- - ---- ---- ---------- ---- - --- --- ------ ------- ------------ -------- ---- ---- ------ ------- -
结论
通过通过 graphql-cli-generate-schema
,你可以轻松生成 SCHEMA,以便在你的应用程序中使用。这是一种与现有 GraphQL 服务器的快速交互的好方法。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005735c81e8991b448e960c