|
1 | | -# Introduction |
| 1 | +[](https://github.com/DaleStudy/graphql/actions/workflows/apollo-check.yml) |
| 2 | +[](https://github.com/DaleStudy/graphql/actions/workflows/apollo-publish.yml) |
2 | 3 |
|
3 | | -π Welcome! |
| 4 | +# GraphQL API |
4 | 5 |
|
5 | | -This template repository is used to initialize an API orchestration project using [Apolloβs Rover CLI](https://www.apollographql.com/docs/rover), [Apollo Connectors](https://www.apollographql.com/docs/graphos/schema-design/connectors), and an example REST API, by providing a structured setup for managing and composing APIs efficiently. |
6 | | - |
7 | | -# Prerequisites |
8 | | - |
9 | | -## Install the Rover CLI |
10 | | -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. |
11 | | - |
12 | | -### MacOS/Linux |
13 | | -``` |
14 | | -curl -sSL https://rover.apollo.dev/nix/latest | sh |
15 | | -``` |
16 | | - |
17 | | -### Windows |
18 | | -``` |
19 | | -iwr 'https://rover.apollo.dev/win/latest' | iex |
20 | | -``` |
21 | | - |
22 | | -## Install and configure the recommended extensions |
23 | | - |
24 | | -### For schema development |
25 | | - |
26 | | -#### VS Code |
27 | | -π [Install Apollo's VS Code extension](https://marketplace.visualstudio.com/items?itemName=apollographql.vscode-apollo) |
28 | | -π [GraphQL development in VS Code](https://www.apollographql.com/docs/graphos/schema-design/ide-support/vs-code) |
29 | | - |
30 | | -#### JetBrains |
31 | | -π [Install Apollo's JetBrains plugin](https://plugins.jetbrains.com/plugin/20645-apollo-graphql) |
32 | | -π [Schema development in JetBrains IDEs](https://www.apollographql.com/docs/graphos/schema-design/ide-support/jetbrains) |
33 | | - |
34 | | -#### Vim/NeoVim |
35 | | -π [Schema development in Vim and NeoVim](https://www.apollographql.com/docs/graphos/schema-design/ide-support/vim) |
36 | | - |
37 | | -### For YAML files |
38 | | - |
39 | | -#### VS Code |
40 | | -π [Install Red Hat's YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) |
41 | | - |
42 | | -## Initialize a new project |
43 | | -``` |
44 | | -rover init |
45 | | -``` |
46 | | - |
47 | | -π **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. |
48 | | - |
49 | | -# Next steps |
50 | | -For further guidance, check out `getting_started.md`. π |
51 | | - |
52 | | -To see more examples of Connectors, check out Apollo's [Connectors Community repo](https://github.com/apollographql/connectors-community). |
| 6 | +π§βπ λ¬λ μ€ν°λμ GraphQL API |
0 commit comments