Introduction

👋 Welcome!

This template repository is used to initialize an API orchestration project using Apollo’s Rover CLI, Apollo Connectors, and an example REST API, by providing a structured setup for managing and composing APIs efficiently.

Prerequisites

Install the Rover CLI

Rover is the primary command-line interface for GraphOS—a necessary tool to interact with graphs using Apollo. If you’ve already installed Rover, you can skip this section.

MacOS/Linux

curl -sSL https://rover.apollo.dev/nix/latest | sh

Windows

iwr 'https://rover.apollo.dev/win/latest' | iex

Install and configure the recommended extensions

For schema development

VS Code

🔗 Install Apollo's VS Code extension 🔗 GraphQL development in VS Code

JetBrains

🔗 Install Apollo's JetBrains plugin 🔗 Schema development in JetBrains IDEs

Vim/NeoVim

🔗 Schema development in Vim and NeoVim

For YAML files

VS Code

🔗 Install Red Hat's YAML extension

Initialize a new project

rover init

📓 Note: If you’re already logged into an existing Apollo organization by the time you run this command, the CLI will nudge you to go to Apollo Studio. From there, you can create a new personal API key to interact with Rover. If you don’t have an account yet, visiting the link will prompt you to create one.

Next steps

For further guidance, check out getting-started.md. 🚀

To see more examples of Connectors, check out Apollo's Connectors Community repo.