Skip to content

EDU-14454 - Create "Developing a GraphQL API in service apps" guide #2071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

henriquessb
Copy link
Contributor

Types of changes

  • New content (guides, endpoints, app documentation)
  • Improvement (make a documentation even better)
  • Fix (fix a documentation error)
  • Spelling and grammar accuracy (self-explanatory)

@henriquessb henriquessb self-assigned this Jul 16, 2025
@henriquessb henriquessb added new Improvements or additions to documentation documentation labels Jul 16, 2025
Copy link
Contributor

github-actions bot commented Jul 16, 2025

Preview Links

Open this URL to set up the portal with this branch changes.

You can now access the edited pages with the following URLs:

Copy link
Contributor

Navigation Preview Link

No changes detected in the navigation.json file

updatedAt: "2025-07-16T14:00:00.000Z"
---

When developing a [service app](https://developers.vtex.com/docs/guides/vtex-io-documentation-service), you may need to expose an API so that other systems, such as other VTEX IO apps or external integrations, can interact with it. There are two options for developing APIs: [REST](https://restfulapi.net/) and [GraphQL](https://graphql.org/). REST is commonly used for interacting with other services and external integrations, while GraphQL is usually recommended for interactions with frontend apps and systems.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[link-check] reported by reviewdog 🐶
🚨 Found a broken link in a Markdown Link (Error 403):
https://restfulapi.net/

👉 Please review this link before merging your Pull Request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation new Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant