Rover模板命令
生成子图模板代码
一个 超级图(也称联邦 graph)是由多个 子图 组成的图:
Rover 模板命令帮助您从模板项目创建新的 子图。支持联邦的子图实现。
这个特性帮助您快速启动新的 GraphQL 项目或探索各种 子图 实现。如果您想贡献一个新的模板, 在此处开通问题!
创建一个新的子图
运行rover template use <PATH>
生成新子图的基础代码。您可以使用向导体验来选择模板,或者使用 --template
标志指定模板。
使用向导
运行 rover template use <PATH>
以启动一个向导,帮助您创建新的子图项目。向导会带您完成一系列问题,以帮助您选择模板。
rover template use my-new-subgraph
默认情况下,向导会提示您选择用于项目的编程语言。您可以提供 --language
选项来跳过此提示。
运行 rover template use --help
来查看可用语言列表。
rover template use my-new-python-subgraph --language python
跳过向导
如果您确切知道要使用哪个模板,可以使用 --template
选项来跳过向导:
rover template use my-new-javascript-subgraph --template subgraph-javascript-apollo-server
使用 rover template list
来查看可用模板列表。
列出可用模板
rover template list 命令列出每个可用的模板及其对应的 ID(您可以在 rover template use
的 --template
选项中提供)。它还显示每个模板的名称、语言和 Repo URL。要了解特定模板的更多信息,请访问其 repo URL 并查看其 README.md
文件。
此命令接受与 rover template use
相同的 --language
选项来过滤模板列表。
要获取机器可读的输出,请使用 --json
标志。
当前以下库和语言提供了可用模板
语言 | 名称 | ID | 模板仓库 |
---|---|---|---|
C# | Hot Chocolate (Annotations) | subgraph-csharp-hot-chocolate | 查看仓库 |
Go | Go (gqlgen) | 图子-go-gqlgen | 查看仓库 |
Java | Spring GraphQL | 图子-java-spring-graphql | 查看仓库 |
JavaScript | Apollo Server (JS) | 图子-javascript-apollo-server | 查看仓库 |
Kotlin | GraphQL Kotlin | 图子-graphql-kotlin | 查看仓库 |
Python | Strawberry with FastAPI | 图子-python-strawberry-fastapi | 查看仓库 |
Python | Ariadne with FastAPI | 图子-python-ariadne-fastapi | 查看仓库 |
Rust | async-graphql with Axum | 图子-rust-async-graphql | 查看仓库 |
TypeScript | Apollo Server (TS) | 图子-typescript-apollo-server | 查看仓库 |