scottk/twenty
1
0
Fork 0
mirror of https://github.com/lingble/twenty.git synced 2025-11-01 21:27:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Migrate to a monorepo structure (#2909)

Browse Source
This commit is contained in:
Charles Bochet
2023-12-10 18:10:54 +01:00
committed by GitHub
parent a70a9281eb
commit 5bdca9de6c
2304 changed files with 37152 additions and 25869 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
packages/twenty-docs/docs/developer/graphql_api.mdx Normal file
View File

@@ -0,0 +1,25 @@
---
title: GraphQL API
sidebar_position: 2
sidebar_custom_props:
icon: TbBrandGraphql
---
Use the [in-browser GraphiQL app](https://docs.twenty.com/graphql/) to browse, query, and mutate the introspection query.
## What is GraphQL?
GraphQL is a query language for APIs that enables declarative data fetching that allows a client to specify the exact data it needs from the API.
Instead of exposing various endpoints that return fixed data structures, GraphQL exposes only a single endpoint that precisely returns the data that the client asked for. This makes GraphQL more flexible and efficient than other kinds of APIs, like REST APIs.
You can learn more about GraphQL by going through this [Introduction](https://www.howtographql.com/basics/0-introduction/).
## About GraphQL Introspection
GraphQL query language is strongly typed, which makes it possible for you to query and understand the underlying schema.
With the Introspection feature, you can query the schema and discover the queries (to request data), mutations (to update data), types, and fields available in a particular GraphQL API.
## Try the GraphQL Playground
You can use the browser-based, interactive [GraphQL playground](https://docs.twenty.com/graphql/) to run mutations and queries to discover valid fields and where you can use them.