From 6ab477df8ddd34eed117f29342b01e0c94435cbc Mon Sep 17 00:00:00 2001 From: syedmouaazfarrukh <97732099+syedmouaazfarrukh@users.noreply.github.com> Date: Tue, 24 Jan 2023 13:52:56 -0800 Subject: [PATCH] Add content to graphql (#3329) * Adding content to 100-graphql-introduction * Adding content to 101-graphql-queries * Adding content to 102-mutations * Adding content to 103-subscriptions * Adding content to 108-frontend-implementation * Adding content to 104-schema * Adding content to 101-resolvers * Adding content to 105-execution * Adding content to 109-backend-implementations * Adding content to 100-graphql-over-http * Adding content to 101-graphql-over-websockets * Adding content to 102-graphql-over-sse * Adding content to 106-serving-over-internet * Adding content to 104-validation, 107-pagination * Adding content to graphql --- .../100-what-is-graphql.md | 11 ++++++++++- .../101-problems-graphql-solves.md | 12 +++++++++++- .../102-thinking-in-graphs.md | 10 +++++++++- .../103-graphql-on-the-frontend.md | 12 +++++++++++- .../104-graphql-on-the-backend.md | 12 +++++++++++- .../content/100-graphql-introduction/index.md | 13 ++++++++++++- .../100-what-are-queries.md | 8 +++++++- .../content/101-graphql-queries/101-fields.md | 10 +++++++++- .../content/101-graphql-queries/102-aliases.md | 8 +++++++- .../101-graphql-queries/103-arguments.md | 8 +++++++- .../101-graphql-queries/104-directives.md | 8 +++++++- .../101-graphql-queries/105-variables.md | 9 ++++++++- .../101-graphql-queries/106-fragments.md | 8 +++++++- .../content/101-graphql-queries/index.md | 10 +++++++++- .../102-mutations/100-what-are-mutations.md | 10 +++++++++- .../101-multiple-mutation-fields.md | 8 +++++++- .../102-mutations/102-operation-name.md | 8 +++++++- .../graphql/content/102-mutations/index.md | 10 +++++++++- .../100-what-are-subscriptions.md | 10 +++++++++- .../101-event-based-subscriptions.md | 6 +++++- .../103-subscriptions/102-live-queries.md | 10 +++++++++- .../103-defer-stream-directives.md | 10 +++++++++- .../graphql/content/103-subscriptions/index.md | 10 +++++++++- .../content/104-schema/100-type-system.md | 14 +++++++++++++- .../graphql/content/104-schema/101-fields.md | 10 +++++++++- .../graphql/content/104-schema/102-scalars.md | 18 +++++++++++++++++- .../graphql/content/104-schema/103-enums.md | 11 ++++++++++- .../graphql/content/104-schema/104-objects.md | 9 ++++++++- .../graphql/content/104-schema/105-lists.md | 10 +++++++++- .../content/104-schema/106-interfaces.md | 10 +++++++++- .../graphql/content/104-schema/107-unions.md | 10 +++++++++- .../content/104-schema/108-arguments.md | 8 +++++++- .../graphql/content/104-schema/index.md | 10 +++++++++- src/roadmaps/graphql/content/104-validation.md | 8 +++++++- .../content/105-execution/100-root-fields.md | 13 ++++++++++++- .../101-resolvers/100-synchronous.md | 6 +++++- .../101-resolvers/101-asynchronous.md | 10 +++++++++- .../101-resolvers/102-scalar-coercion.md | 10 +++++++++- .../105-execution/101-resolvers/103-lists.md | 10 +++++++++- .../105-execution/101-resolvers/index.md | 10 +++++++++- .../content/105-execution/102-validation.md | 10 +++++++++- .../105-execution/103-producing-the-result.md | 15 ++++++++++++++- .../graphql/content/105-execution/index.md | 9 ++++++++- .../100-graphql-over-http/100-caching.md | 14 +++++++++++++- .../100-graphql-over-http/101-batching.md | 10 +++++++++- .../100-graphql-over-http/102-authorization.md | 14 +++++++++++++- .../100-graphql-over-http/index.md | 10 +++++++++- .../100-real-time.md | 8 +++++++- .../101-authorization.md | 14 +++++++++++++- .../101-graphql-over-websockets/index.md | 8 +++++++- .../102-graphql-over-sse/100-authorization.md | 14 +++++++++++++- .../102-graphql-over-sse/index.md | 12 +++++++++++- .../content/106-serving-over-internet/index.md | 14 +++++++++++++- src/roadmaps/graphql/content/107-pagination.md | 14 +++++++++++++- .../108-frontend-implementations/100-relay.md | 10 +++++++++- .../101-apollo-client.md | 10 +++++++++- .../108-frontend-implementations/102-urql.md | 4 +++- .../108-frontend-implementations/index.md | 11 ++++++++++- .../100-graphql-http.md | 14 +++++++++++++- .../101-graphql-yoga.md | 10 +++++++++- .../102-apollo-server.md | 10 +++++++++- .../103-mercurius.md | 6 +++++- .../109-backend-implementations/index.md | 13 ++++++++++++- 63 files changed, 589 insertions(+), 63 deletions(-) diff --git a/src/roadmaps/graphql/content/100-graphql-introduction/100-what-is-graphql.md b/src/roadmaps/graphql/content/100-graphql-introduction/100-what-is-graphql.md index 11e755835..95a32b054 100644 --- a/src/roadmaps/graphql/content/100-graphql-introduction/100-what-is-graphql.md +++ b/src/roadmaps/graphql/content/100-graphql-introduction/100-what-is-graphql.md @@ -1 +1,10 @@ -# What is graphql \ No newline at end of file +# What is GraphQL + +GraphQL is a query language for your API, and a server-side runtime for executing queries using a type system you define for your data. GraphQL isn't tied to any specific database or storage engine and is instead backed by your existing code and data. + +A GraphQL service is created by defining types and fields on those types, then providing functions for each field on each type. + +To learn more, visit the following links: + +- [Introduction to graphQL](https://graphql.org/learn/) +- [Tutorial - What is graphQL?](https://www.howtographql.com/basics/0-introduction/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/100-graphql-introduction/101-problems-graphql-solves.md b/src/roadmaps/graphql/content/100-graphql-introduction/101-problems-graphql-solves.md index 007c67964..e3884586a 100644 --- a/src/roadmaps/graphql/content/100-graphql-introduction/101-problems-graphql-solves.md +++ b/src/roadmaps/graphql/content/100-graphql-introduction/101-problems-graphql-solves.md @@ -1 +1,11 @@ -# Problems graphql solves \ No newline at end of file +# Problems GraphQL Solves + +GraphQL solves several problems commonly faced when building APIs, including: + +- **Over-fetching:** With REST APIs, the client often receives more data than it needs, resulting in wasted bandwidth and slow performance. GraphQL allows the client to specify exactly the data it needs, reducing over-fetching. + +- **Under-fetching:** With REST, the client often has to make multiple requests to different endpoints to gather all the data it needs, resulting in additional latency and complexity. GraphQL allows the client to request all the necessary data in a single request. + +- **Inefficient versioning:** With REST, creating a new endpoint for each version of an API can quickly become cumbersome and hard to maintain. GraphQL allows for seamless versioning by adding new fields and types, rather than creating new endpoints. + +- **Lack of flexibility:** REST APIs are typically fixed, meaning that the client has to work with the data structure provided by the API. GraphQL allows the client to request exactly the data it needs and receive it in a predictable format, increasing flexibility. \ No newline at end of file diff --git a/src/roadmaps/graphql/content/100-graphql-introduction/102-thinking-in-graphs.md b/src/roadmaps/graphql/content/100-graphql-introduction/102-thinking-in-graphs.md index c3d208ad6..6cd1cdfbe 100644 --- a/src/roadmaps/graphql/content/100-graphql-introduction/102-thinking-in-graphs.md +++ b/src/roadmaps/graphql/content/100-graphql-introduction/102-thinking-in-graphs.md @@ -1 +1,9 @@ -# Thinking in graphs \ No newline at end of file +# Thinking in Graphs + +"Thinking in Graphs" is a mindset or approach when working with GraphQL. It refers to the way that data is organized and queried in GraphQL, which is based on the concept of a graph. + +In GraphQL, data is represented as a graph, where nodes represent objects and edges represent relationships between them. This allows for a more flexible and intuitive way of querying data, as the client can specify exactly the data it needs by following the relationships between nodes in the graph. + +Learn more from the following links: + +- [GraphQL - Thinking in Graphs](https://graphql.org/learn/thinking-in-graphs/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/100-graphql-introduction/103-graphql-on-the-frontend.md b/src/roadmaps/graphql/content/100-graphql-introduction/103-graphql-on-the-frontend.md index 540ce73eb..305c10a63 100644 --- a/src/roadmaps/graphql/content/100-graphql-introduction/103-graphql-on-the-frontend.md +++ b/src/roadmaps/graphql/content/100-graphql-introduction/103-graphql-on-the-frontend.md @@ -1 +1,11 @@ -# Graphql on the frontend \ No newline at end of file +# GraphQL on the Frontend + +In GraphQL, the frontend refers to the client-side of the application, typically the web or mobile app that the end-user interacts with. + +When using GraphQL on the frontend, developers can use a GraphQL client library, such as Apollo Client or Relay, to interact with the GraphQL server. These libraries provide a way to easily send GraphQL queries and mutations to the server and handle the response. + +By using GraphQL on the frontend, developers can benefit from the flexibility and efficiency of GraphQL when querying data. Instead of having to make multiple REST API calls or hardcode data into the frontend, the client can specify exactly the data it needs in a single request, and the server will return it in a predictable format. + +Learn more from following links: + +- [Get started with GraphQL on the frontend](https://www.howtographql.com/react-apollo/0-introduction/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/100-graphql-introduction/104-graphql-on-the-backend.md b/src/roadmaps/graphql/content/100-graphql-introduction/104-graphql-on-the-backend.md index 25cce9195..0faf3c1bb 100644 --- a/src/roadmaps/graphql/content/100-graphql-introduction/104-graphql-on-the-backend.md +++ b/src/roadmaps/graphql/content/100-graphql-introduction/104-graphql-on-the-backend.md @@ -1 +1,11 @@ -# Graphql on the backend \ No newline at end of file +# GraphQL on the Backend + +In GraphQL, the backend refers to the server-side of the application, where the data is stored and processed. + +When using GraphQL on the backend, developers can create a GraphQL server that handles the incoming GraphQL queries and mutations from the frontend. This can be implemented using a GraphQL library or framework, such as Apollo Server, Express-GraphQL, or GraphQL-Java. + +The GraphQL server is responsible for handling the incoming queries and mutations, validating them against a schema, and executing them by fetching data from the database or other data sources. The server then returns the requested data to the client in a predictable format, as defined by the schema. + +Learn more from the following links: + +- [How to use GraphQL in Backend?](https://www.howtographql.com/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/100-graphql-introduction/index.md b/src/roadmaps/graphql/content/100-graphql-introduction/index.md index 8c5278f5a..daad4625e 100644 --- a/src/roadmaps/graphql/content/100-graphql-introduction/index.md +++ b/src/roadmaps/graphql/content/100-graphql-introduction/index.md @@ -1 +1,12 @@ -# Graphql introduction \ No newline at end of file +# GraphQL Introduction + +GraphQL is a query language and runtime for APIs. It is used to build and consume web service APIs. + +GraphQL allows clients to make a single API call to request exactly the data they need, in a predictable format. This allows for more efficient and flexible data retrieval, compared to traditional REST APIs where the client has to make multiple API calls to different endpoints, and may receive more data than it needs. + +With GraphQL, the client defines the structure of the data it needs, by sending a query to the server. The server then returns the requested data in the same structure, as defined by the query. The client can also make mutations to update or create data on the server. + +To learn more, visit the following links: + +- [Introduction to GraphQL](https://graphql.org/learn/) +- [Getting started with GraphQL](https://graphql.org/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/101-graphql-queries/100-what-are-queries.md b/src/roadmaps/graphql/content/101-graphql-queries/100-what-are-queries.md index 1170a166b..30f3db71a 100644 --- a/src/roadmaps/graphql/content/101-graphql-queries/100-what-are-queries.md +++ b/src/roadmaps/graphql/content/101-graphql-queries/100-what-are-queries.md @@ -1 +1,7 @@ -# What are queries \ No newline at end of file +# What are Queries + +In GraphQL, a query is a request made by the client to the server to retrieve data. Queries are used to fetch data from the server and are structured as a hierarchical tree of fields, which correspond to the properties of the data being requested. + +Learn more from following links: + +- [Introduction of GraphQL - Query](https://graphql.org/learn/queries/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/101-graphql-queries/101-fields.md b/src/roadmaps/graphql/content/101-graphql-queries/101-fields.md index 70dd38e66..c2c3a5eaf 100644 --- a/src/roadmaps/graphql/content/101-graphql-queries/101-fields.md +++ b/src/roadmaps/graphql/content/101-graphql-queries/101-fields.md @@ -1 +1,9 @@ -# Fields \ No newline at end of file +# Fields + +In GraphQL, fields are the individual pieces of data that can be queried or modified. They represent the properties of the data being requested or modified, and are the building blocks of queries and mutations. + +Fields are defined in the GraphQL schema, which is a blueprint of the data that can be queried and modified. The schema defines the types of data that can be queried, and the fields that are available for each type. + +Learn more from the following links: + +- [GraphQL: Types and Fields](https://graphql.org/learn/queries/#fields) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/101-graphql-queries/102-aliases.md b/src/roadmaps/graphql/content/101-graphql-queries/102-aliases.md index 1487a25f2..21fe89d08 100644 --- a/src/roadmaps/graphql/content/101-graphql-queries/102-aliases.md +++ b/src/roadmaps/graphql/content/101-graphql-queries/102-aliases.md @@ -1 +1,7 @@ -# Aliases \ No newline at end of file +# Aliases + +Aliases in GraphQL are a way to rename fields when they are requested in a query. They are useful in situations where a field is requested multiple times, but with different arguments, or when the field has a name that is not suitable for the client's usage. They make it easy to distinguish and work with fields in the response and make the query more readable. + +To learn more, visit the following links: + +- [What are GraphQL Aliases?](https://graphql.org/learn/queries/#aliases) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/101-graphql-queries/103-arguments.md b/src/roadmaps/graphql/content/101-graphql-queries/103-arguments.md index de7633005..04e75550b 100644 --- a/src/roadmaps/graphql/content/101-graphql-queries/103-arguments.md +++ b/src/roadmaps/graphql/content/101-graphql-queries/103-arguments.md @@ -1 +1,7 @@ -# Arguments \ No newline at end of file +# Arguments + +Arguments in GraphQL are pieces of information that are passed to a field or a directive to specify additional details about how the field should be executed. They can be used to filter, sort, or paginate data, or to specify additional options when creating, updating, or deleting data. They can be passed as key-value pairs, defined as variables, and can be optional or required. + +Learn more from the following links: + +- [GraphQL - Arguments](https://graphql.org/learn/queries/#arguments) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/101-graphql-queries/104-directives.md b/src/roadmaps/graphql/content/101-graphql-queries/104-directives.md index 511998d02..9122c844a 100644 --- a/src/roadmaps/graphql/content/101-graphql-queries/104-directives.md +++ b/src/roadmaps/graphql/content/101-graphql-queries/104-directives.md @@ -1 +1,7 @@ -# Directives \ No newline at end of file +# Directives + +Directives in GraphQL are a way to modify the execution of a query or a field. They are used to add additional behavior or validation to a query or a field, and can be applied to fields, operations (queries and mutations) and fragments. Directives can take one or more arguments to configure their behavior, and can be defined by the developer or used one of the built-in directives provided by GraphQL. + +To learn more, visit the following links: + +- [Directives in GraphQL](https://graphql.org/learn/queries/#directives) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/101-graphql-queries/105-variables.md b/src/roadmaps/graphql/content/101-graphql-queries/105-variables.md index bb79b115c..29edd83c7 100644 --- a/src/roadmaps/graphql/content/101-graphql-queries/105-variables.md +++ b/src/roadmaps/graphql/content/101-graphql-queries/105-variables.md @@ -1 +1,8 @@ -# Variables \ No newline at end of file +# Variables + +Variables in GraphQL are a way to pass dynamic values to a query or a mutation. They allow the client to make a query more dynamic and flexible by passing in different values for the same argument. They are defined in the query or mutation using the **$** symbol followed by the variable name and a type, and their values must be passed in a separate JSON object. They also are type-safe, this means that variables must be passed values that are of the same type as defined in the query. + +To learn more, visit the following links: + +- [GraphQL Variables](https://dgraph.io/docs/graphql/api/variables/) +- [Intro to Variables in GraphQL](https://graphql.org/learn/queries/#variables) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/101-graphql-queries/106-fragments.md b/src/roadmaps/graphql/content/101-graphql-queries/106-fragments.md index 81225f465..13b171b53 100644 --- a/src/roadmaps/graphql/content/101-graphql-queries/106-fragments.md +++ b/src/roadmaps/graphql/content/101-graphql-queries/106-fragments.md @@ -1 +1,7 @@ -# Fragments \ No newline at end of file +# Fragments + +In GraphQL, a fragment is a reusable piece of a GraphQL query that can be used to retrieve specific fields from one or more types of data. A fragment is defined using the "fragment" keyword, followed by the name of the fragment and the type of data it is querying. The fields to be retrieved are then specified within curly braces. + +To learn more, visit the following links: + +- [Intro to Fragments in GraphQL](https://graphql.org/learn/queries/#fragments) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/101-graphql-queries/index.md b/src/roadmaps/graphql/content/101-graphql-queries/index.md index 29779dc13..5e5b30719 100644 --- a/src/roadmaps/graphql/content/101-graphql-queries/index.md +++ b/src/roadmaps/graphql/content/101-graphql-queries/index.md @@ -1 +1,9 @@ -# Graphql queries \ No newline at end of file +# GraphQL Queries + +GraphQL is a query language for APIs. It provides a simple and flexible syntax for making requests to a server to retrieve specific data. In GraphQL, a query is a request made to the server to fetch data. The query specifies the fields of the data that should be returned, and the server responds with the requested data. + +A GraphQL query is structured as a single object, with a "query" or "mutation" field at the top level. The "query" field is used to retrieve data, while the "mutation" field is used to make changes to the data. The query is written in a specific format and is executed by the server to retrieve the requested data. + +To learn more, visit the following links: + +- [What are GraphQL Queries?](https://graphql.org/learn/queries/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/102-mutations/100-what-are-mutations.md b/src/roadmaps/graphql/content/102-mutations/100-what-are-mutations.md index 686d3f342..86b04c7c3 100644 --- a/src/roadmaps/graphql/content/102-mutations/100-what-are-mutations.md +++ b/src/roadmaps/graphql/content/102-mutations/100-what-are-mutations.md @@ -1 +1,9 @@ -# What are mutations \ No newline at end of file +# What are Mutations + +In GraphQL, a mutation is a type of query used to make changes to data on the server. It is used to create, update, or delete data, and is structured similarly to a query, but with a "mutation" field at the top level instead of a "query" field. + +A mutation typically includes fields that specify the data to be changed and the operation to be performed (e.g. "create", "update", or "delete"). It can also include arguments to specify the specific data to be affected. + +Learn more from the following resources: + +- [Get started with Mutations](https://graphql.org/learn/queries/#mutations) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/102-mutations/101-multiple-mutation-fields.md b/src/roadmaps/graphql/content/102-mutations/101-multiple-mutation-fields.md index 05cc9a338..4e3388a9c 100644 --- a/src/roadmaps/graphql/content/102-mutations/101-multiple-mutation-fields.md +++ b/src/roadmaps/graphql/content/102-mutations/101-multiple-mutation-fields.md @@ -1 +1,7 @@ -# Multiple mutation fields \ No newline at end of file +# Multiple Mutation Fields + +In GraphQL, it is possible to perform multiple mutations in a single query by including multiple "mutation" fields in the query. This is called "batching" or "chaining" mutations. + +Learn more from the following links: + +- [Guide to Multiple fields in mutations](https://graphql.org/learn/queries/#multiple-fields-in-mutations) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/102-mutations/102-operation-name.md b/src/roadmaps/graphql/content/102-mutations/102-operation-name.md index 67807e90a..f5eba5e10 100644 --- a/src/roadmaps/graphql/content/102-mutations/102-operation-name.md +++ b/src/roadmaps/graphql/content/102-mutations/102-operation-name.md @@ -1 +1,7 @@ -# Operation name \ No newline at end of file +# Operation Name + +In GraphQL, an operation name is an optional identifier that can be used to uniquely identify a query or a mutation in a document containing multiple operations. It can be used to provide more meaningful names for operations, making it easier to understand the purpose of the operation and to identify it in the event of an error. + +Learn more from the following resources: + +- [Intro to Operation Name](https://graphql.org/learn/queries/#operation-name) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/102-mutations/index.md b/src/roadmaps/graphql/content/102-mutations/index.md index 520d34a37..7339efa5d 100644 --- a/src/roadmaps/graphql/content/102-mutations/index.md +++ b/src/roadmaps/graphql/content/102-mutations/index.md @@ -1 +1,9 @@ -# Mutations \ No newline at end of file +# Mutations + +In GraphQL, a mutation is a type of query used to make changes to the data on the server, such as creating, updating, or deleting data. A mutation is structured similarly to a query, but with a "mutation" field at the top level instead of a "query" field. + +The mutation includes fields that specify the data to be changed, the operation to be performed (create, update or delete) and also can include arguments to specify the specific data to be affected. + +To learn more, visit the following links: + +- [Getting started with Mutations](https://graphql.org/learn/queries/#mutations) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/103-subscriptions/100-what-are-subscriptions.md b/src/roadmaps/graphql/content/103-subscriptions/100-what-are-subscriptions.md index 842bb0275..e0dd3330e 100644 --- a/src/roadmaps/graphql/content/103-subscriptions/100-what-are-subscriptions.md +++ b/src/roadmaps/graphql/content/103-subscriptions/100-what-are-subscriptions.md @@ -1 +1,9 @@ -# What are subscriptions \ No newline at end of file +# What are Subscriptions + +In GraphQL, subscriptions are a way to push real-time updates to the client. They allow a client to subscribe to a specific event or data change on the server, and receive updates in real-time as soon as the event occurs or the data changes. + +Subscriptions are defined on the server and are structured similar to queries and mutations. They have a "subscription" field at the top level, followed by the fields that define the event or data change to be subscribed to. + +To learn more, visit the following links: + +- [How GraphQL Subscriptions Work?](https://the-guild.dev/blog/subscriptions-and-live-queries-real-time-with-graphql) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/103-subscriptions/101-event-based-subscriptions.md b/src/roadmaps/graphql/content/103-subscriptions/101-event-based-subscriptions.md index 861aae1b4..ce38e5d6e 100644 --- a/src/roadmaps/graphql/content/103-subscriptions/101-event-based-subscriptions.md +++ b/src/roadmaps/graphql/content/103-subscriptions/101-event-based-subscriptions.md @@ -1 +1,5 @@ -# Event based subscriptions \ No newline at end of file +# Event Based Subscriptions + +Event-based subscriptions in GraphQL are a way to push real-time updates to the client based on specific events that occur on the server. These events can be triggered by external sources such as user actions, sensor data, or other systems, or by internal actions such as database updates. + +With event-based subscriptions, the client can subscribe to a specific event or set of events and receive updates in real-time as soon as the event occurs. This allows the client to receive notifications about important changes in the system without the need to constantly poll the server for updates. \ No newline at end of file diff --git a/src/roadmaps/graphql/content/103-subscriptions/102-live-queries.md b/src/roadmaps/graphql/content/103-subscriptions/102-live-queries.md index 425267a90..c8e5d7475 100644 --- a/src/roadmaps/graphql/content/103-subscriptions/102-live-queries.md +++ b/src/roadmaps/graphql/content/103-subscriptions/102-live-queries.md @@ -1 +1,9 @@ -# Live queries \ No newline at end of file +# Live Queries + +In GraphQL, live queries, also known as "real-time queries" or "subscriptions to queries", is a way to push real-time updates to the client, when the data that is being queried changes on the server. It allows the client to subscribe to a specific query and receive updates in real-time as soon as the data changes. + +With live queries, the client can subscribe to a specific query and receive updates when the data that is being queried changes on the server. The client can also specify the fields and arguments of the query, and the server will only send updates for the fields that the client has requested. + +Learn more from the following links: + +- [GraphQL Live Queries](https://the-guild.dev/blog/collecting-graphql-live-query-resource-identifier-with-graphql-tools) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/103-subscriptions/103-defer-stream-directives.md b/src/roadmaps/graphql/content/103-subscriptions/103-defer-stream-directives.md index f367ca34e..4cd306b6a 100644 --- a/src/roadmaps/graphql/content/103-subscriptions/103-defer-stream-directives.md +++ b/src/roadmaps/graphql/content/103-subscriptions/103-defer-stream-directives.md @@ -1 +1,9 @@ -# Defer stream directives \ No newline at end of file +# Defer Stream Directives + +In GraphQL, the "defer" and "stream" directives are used to control the handling of fields and their associated data. These directives allow developers to control how data is fetched and sent over the network, and can be used to optimize the performance of a GraphQL API. + +The "defer" directive is used to delay the fetching of a field's data until the data is actually needed by the client. This can be useful for improving the performance of an API by reducing the amount of data that needs to be fetched upfront. + +Learn more from the following links: + +- [Defer and Stream in GraphQL](https://the-guild.dev/graphql/yoga-server/docs/features/defer-stream) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/103-subscriptions/index.md b/src/roadmaps/graphql/content/103-subscriptions/index.md index bef80be2a..d3ca0b918 100644 --- a/src/roadmaps/graphql/content/103-subscriptions/index.md +++ b/src/roadmaps/graphql/content/103-subscriptions/index.md @@ -1 +1,9 @@ -# Subscriptions \ No newline at end of file +# Subscriptions + +In GraphQL, subscriptions are a way to push real-time updates to the client. They allow a client to subscribe to specific events or data changes on the server, and receive updates in real-time as soon as the event occurs or the data changes. Subscriptions are defined on the server and are structured similarly to queries and mutations. + +A subscription includes a "subscription" field at the top level, followed by the fields that define the event or data change to be subscribed to. The client can initiate the subscription by sending the subscription query to the server, and the server will keep the connection open, listening for new events or data changes. Once the event occurs, or the data changes, the server will send the updated data to the client through the open connection. + +Learn more from following links: + +- [Subscriptions and Live Queries - Real Time with GraphQL](https://the-guild.dev/blog/subscriptions-and-live-queries-real-time-with-graphql) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/104-schema/100-type-system.md b/src/roadmaps/graphql/content/104-schema/100-type-system.md index 7b44d60d1..e27deee8c 100644 --- a/src/roadmaps/graphql/content/104-schema/100-type-system.md +++ b/src/roadmaps/graphql/content/104-schema/100-type-system.md @@ -1 +1,13 @@ -# Type system \ No newline at end of file +# Type System + +GraphQL is a strongly typed language. Type System defines various data types that can be used in a GraphQL application. The type system helps to define the schema, which is a contract between client and server. The commonly used GraphQL data types are as follows: + +- Scalar +- Object +- Query +- Mutation +- Enum + +Learn more from the following links: + +- [Get started with Type system](https://graphql.org/learn/schema/#type-system) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/104-schema/101-fields.md b/src/roadmaps/graphql/content/104-schema/101-fields.md index 70dd38e66..710aff427 100644 --- a/src/roadmaps/graphql/content/104-schema/101-fields.md +++ b/src/roadmaps/graphql/content/104-schema/101-fields.md @@ -1 +1,9 @@ -# Fields \ No newline at end of file +# Fields + +In GraphQL, a field is a unit of data that can be queried or manipulated in a request. Each field has a name, a type, and an optional description. Fields are defined within an object type in a GraphQL schema. + +Each field in a GraphQL schema can return a scalar value (such as a string or an integer) or another object, allowing for the creation of complex, nested data structures. The fields can also take arguments, which allows to filter or modify the data being returned. + +Learn more from the following links: + +- [GraphQL: Types and Fields](https://graphql.org/learn/queries/#fields) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/104-schema/102-scalars.md b/src/roadmaps/graphql/content/104-schema/102-scalars.md index cef903167..1bc3d9bcf 100644 --- a/src/roadmaps/graphql/content/104-schema/102-scalars.md +++ b/src/roadmaps/graphql/content/104-schema/102-scalars.md @@ -1 +1,17 @@ -# Scalars \ No newline at end of file +# Scalars + +Scalars are “leaf” values in GraphQL. There are several built-in scalars, and you can define custom scalars, too. (Enums are also leaf values.) The built-in scalars are: + +- **String**, like a JSON or Ruby string +- **Int**, like a JSON or Ruby integer +- **Float**, like a JSON or Ruby floating point decimal +- **Boolean**, like a JSON or Ruby boolean (true or false) +- **ID**, which a specialized String for representing unique object identifiers +- **ISO8601DateTime**, an ISO 8601-encoded datetime +- **ISO8601Date**, an ISO 8601-encoded date +- **JSON**, This returns arbitrary JSON (Ruby hashes, arrays, strings, integers, floats, booleans and nils). Take care: by using this type, you completely lose all GraphQL type safety. Consider building object types for your data instead. +- **BigInt**, a numeric value which may exceed the size of a 32-bit integer + +Learn more from the following links: + +- [Get started with Scalars in GraphQL](https://graphql.org/learn/schema/#scalar-types) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/104-schema/103-enums.md b/src/roadmaps/graphql/content/104-schema/103-enums.md index 1cf9f0037..fbf71f5dc 100644 --- a/src/roadmaps/graphql/content/104-schema/103-enums.md +++ b/src/roadmaps/graphql/content/104-schema/103-enums.md @@ -1 +1,10 @@ -# Enums \ No newline at end of file +# Enums + +Enums also called as enumeration types are a special kind of scalar that is restricted to a particular set of allowed values. This allows you to: + +- Validate that any arguments of this type are one of the allowed values +- Communicate through the type system that a field will always be one of a finite set of values + +Learn more from the following links: + +- [What are Enums?](https://graphql.org/learn/schema/#enumeration-types) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/104-schema/104-objects.md b/src/roadmaps/graphql/content/104-schema/104-objects.md index db71f7e72..0d03e96d4 100644 --- a/src/roadmaps/graphql/content/104-schema/104-objects.md +++ b/src/roadmaps/graphql/content/104-schema/104-objects.md @@ -1 +1,8 @@ -# Objects \ No newline at end of file +# Objects + +In GraphQL, an object is a type that represents a group of fields. Objects can be used to define the structure of a query or a mutation. Each field of an object can return a scalar value (such as a string or an integer) or another object, allowing for the creation of complex, nested data structures. In a GraphQL schema, objects are defined using the **type** keyword, followed by the object's name and a set of fields in curly braces. + +To learn more, visit the following: + +- [Object Types and Fields](https://graphql.org/learn/schema/#object-types-and-fields) +- [Object Types](https://graphql.org/graphql-js/object-types/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/104-schema/105-lists.md b/src/roadmaps/graphql/content/104-schema/105-lists.md index 96bf734a5..d317e204d 100644 --- a/src/roadmaps/graphql/content/104-schema/105-lists.md +++ b/src/roadmaps/graphql/content/104-schema/105-lists.md @@ -1 +1,9 @@ -# Lists \ No newline at end of file +# Lists + +In GraphQL, a list is a type that represents an ordered collection of items. Lists are defined using square brackets, with the type of the items inside. + +Lists are used to represent an array of items in a GraphQL schema, and can be used as the return type for a field in an object type. Lists can contain any type of items, including scalars and other objects, and can also be nested within other lists. + +Learn more from the following links: + +- [Get started with Lists](https://graphql.org/learn/schema/#lists-and-non-null) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/104-schema/106-interfaces.md b/src/roadmaps/graphql/content/104-schema/106-interfaces.md index ae1d147ef..e2060c02f 100644 --- a/src/roadmaps/graphql/content/104-schema/106-interfaces.md +++ b/src/roadmaps/graphql/content/104-schema/106-interfaces.md @@ -1 +1,9 @@ -# Interfaces \ No newline at end of file +# Interfaces + +In GraphQL, an interface is a type that defines a set of fields that a type must implement. Interfaces are defined using the interface keyword, and can be used to define common fields for multiple types. + +In GraphQL, lists can also be used within interfaces to define the return type for fields. + +Learn more from the following links: + +- [Get started with Interfaces](https://graphql.org/learn/schema/#interfaces) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/104-schema/107-unions.md b/src/roadmaps/graphql/content/104-schema/107-unions.md index 6504457cd..6e35131b7 100644 --- a/src/roadmaps/graphql/content/104-schema/107-unions.md +++ b/src/roadmaps/graphql/content/104-schema/107-unions.md @@ -1 +1,9 @@ -# Unions \ No newline at end of file +# Unions + +Unions are useful in cases where a field can return multiple types and you want to handle those types differently in your client. They also allow for more flexibility in how you structure your schema, as you can group types together that share common fields. + +Unions don't allow to specify a common set of fields to be queried across multiple types, but it allows to handle multiple types differently in your client. + +Learn more from the following links: + +- [Get started with Union in GraphQL](https://graphql.org/learn/schema/#union-types) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/104-schema/108-arguments.md b/src/roadmaps/graphql/content/104-schema/108-arguments.md index de7633005..25b064c3d 100644 --- a/src/roadmaps/graphql/content/104-schema/108-arguments.md +++ b/src/roadmaps/graphql/content/104-schema/108-arguments.md @@ -1 +1,7 @@ -# Arguments \ No newline at end of file +# Arguments + +In GraphQL, an argument is a value that is passed to a field in a query or mutation. Arguments allow you to filter or modify the data being returned by a field. Arguments are defined within a field in a GraphQL schema, and have a name, a type, and an optional default value. + +To learn more, visit the following links: + +- [Get started with Arguments in GraphQL](https://graphql.org/learn/schema/#arguments) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/104-schema/index.md b/src/roadmaps/graphql/content/104-schema/index.md index 9946ba95f..d839363ff 100644 --- a/src/roadmaps/graphql/content/104-schema/index.md +++ b/src/roadmaps/graphql/content/104-schema/index.md @@ -1 +1,9 @@ -# Schema \ No newline at end of file +# Schema + +In GraphQL, a schema is a blueprint that defines the types, fields, and operations (queries and mutations) that are available to clients. The schema is the contract between the client and the server, specifying what data can be requested and how it can be modified. + +A GraphQL schema is defined using the GraphQL Schema Definition Language (SDL), which is a human-readable syntax for defining the structure of a GraphQL API. The SDL includes keywords such as **type**, **query**, **mutation**, **field**, and **argument** to define the different components of a schema. + +Learn more from the following links: + +- [Get started with Schema](https://graphql.org/learn/schema/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/104-validation.md b/src/roadmaps/graphql/content/104-validation.md index 0d70767ab..2f006dfcc 100644 --- a/src/roadmaps/graphql/content/104-validation.md +++ b/src/roadmaps/graphql/content/104-validation.md @@ -1 +1,7 @@ -# Validation \ No newline at end of file +# Validation + +Validation in GraphQL refers to the process of checking whether a GraphQL query or mutation conforms to the rules and constraints defined in the GraphQL schema. This can include checking that the query or mutation includes the required fields, that the arguments passed to a field are of the correct type, and that the values passed to fields or arguments fall within the expected range. + +Learn more from the following links: + +- [Get Started with Validation in GraphQL](https://graphql.org/learn/validation/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/105-execution/100-root-fields.md b/src/roadmaps/graphql/content/105-execution/100-root-fields.md index d0324c3bb..40097bc15 100644 --- a/src/roadmaps/graphql/content/105-execution/100-root-fields.md +++ b/src/roadmaps/graphql/content/105-execution/100-root-fields.md @@ -1 +1,12 @@ -# Root fields \ No newline at end of file +# Root Fields + +In GraphQL, the root fields are the top-level fields that are available to clients in a query or mutation. They are defined in the schema and are the entry point for client requests. The root fields represent the operations that can be performed on the data, such as querying for data or modifying data. + +There are two types of root fields in GraphQL: + +- **Query:** defines the fields that can be queried to retrieve data from the server. +- **Mutation:** defines the fields that can be used to create, update, or delete data on the server. + +Learn more from the following links: + +- [Get Started with Root Feilds](https://graphql.org/learn/execution/#root-fields-resolvers) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/105-execution/101-resolvers/100-synchronous.md b/src/roadmaps/graphql/content/105-execution/101-resolvers/100-synchronous.md index 7b78737b8..a040af36a 100644 --- a/src/roadmaps/graphql/content/105-execution/101-resolvers/100-synchronous.md +++ b/src/roadmaps/graphql/content/105-execution/101-resolvers/100-synchronous.md @@ -1 +1,5 @@ -# Synchronous \ No newline at end of file +# Synchronous + +In GraphQL, a resolver is a function that is responsible for fetching the data for a field in a query or mutation. Resolvers are defined in the schema and are executed by the GraphQL server when a query or mutation is received. + +A synchronous resolver is a type of resolver that runs and completes its execution before returning any value. It directly returns the result of the computation, without waiting for any external event such as a database query or a third-party API call. \ No newline at end of file diff --git a/src/roadmaps/graphql/content/105-execution/101-resolvers/101-asynchronous.md b/src/roadmaps/graphql/content/105-execution/101-resolvers/101-asynchronous.md index 2340f8c71..932c93696 100644 --- a/src/roadmaps/graphql/content/105-execution/101-resolvers/101-asynchronous.md +++ b/src/roadmaps/graphql/content/105-execution/101-resolvers/101-asynchronous.md @@ -1 +1,9 @@ -# Asynchronous \ No newline at end of file +# Asynchronous + +In GraphQL, a resolver is a function that is responsible for fetching the data for a field in a query or mutation. Resolvers are defined in the schema and are executed by the GraphQL server when a query or mutation is received. + +An asynchronous resolver is a type of resolver that runs, but instead of returning the final value, it returns a promise that will be resolved with the final value. This allows the resolver to wait for an external event such as a database query or a third-party API call to complete before returning the result. + +Learn more from the following links: + +- [Get Started with Asynchronous](https://graphql.org/learn/execution/#asynchronous-resolvers) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/105-execution/101-resolvers/102-scalar-coercion.md b/src/roadmaps/graphql/content/105-execution/101-resolvers/102-scalar-coercion.md index 698613bb2..08970d70d 100644 --- a/src/roadmaps/graphql/content/105-execution/101-resolvers/102-scalar-coercion.md +++ b/src/roadmaps/graphql/content/105-execution/101-resolvers/102-scalar-coercion.md @@ -1 +1,9 @@ -# Scalar coercion \ No newline at end of file +# Scalar Coercion + +In GraphQL, scalar coercion is the process of converting a value from one type to another, as it flows through the resolvers. This is needed when the input value for a field does not match the expected type, but can still be successfully converted to the correct type. + +Scalar coercion can be implemented in the resolvers by using the **GraphQLScalarType** constructor to define a custom scalar type and providing a **coerce** function that can convert the input value to the correct type. + +Learn more from the following links: + +- [Get started with Scalar coercion](https://graphql.org/learn/execution/#scalar-coercion) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/105-execution/101-resolvers/103-lists.md b/src/roadmaps/graphql/content/105-execution/101-resolvers/103-lists.md index 96bf734a5..6fc435d7e 100644 --- a/src/roadmaps/graphql/content/105-execution/101-resolvers/103-lists.md +++ b/src/roadmaps/graphql/content/105-execution/101-resolvers/103-lists.md @@ -1 +1,9 @@ -# Lists \ No newline at end of file +# Lists + +In GraphQL, a list is a type that represents an ordered collection of items. Lists can be used as the return type for a field in a query or mutation, and can contain any type of items, including scalars and objects. + +The resolver function for a list field can retrieve the data from a database or a third-party API and return it as an array. + +Learn more from the following links: + +- [Get started with Lists and Non-Null](https://graphql.org/learn/schema/#lists-and-non-null) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/105-execution/101-resolvers/index.md b/src/roadmaps/graphql/content/105-execution/101-resolvers/index.md index 9b73464fc..07b8a9ca8 100644 --- a/src/roadmaps/graphql/content/105-execution/101-resolvers/index.md +++ b/src/roadmaps/graphql/content/105-execution/101-resolvers/index.md @@ -1 +1,9 @@ -# Resolvers \ No newline at end of file +# Resolvers + +In GraphQL, a resolver is a function that is responsible for fetching the data for a field in a query or mutation. Resolvers are defined in the schema and are executed by the GraphQL server when a query or mutation is received. + +Each field in a GraphQL schema has a corresponding resolver function that is responsible for returning the data for that field. The resolver function can retrieve the data from a database, a third-party API, or any other source, and return it to the client. + +Learn more from the following links: + +- [Guide to Resolver](https://the-guild.dev/blog/better-type-safety-for-resolvers-with-graphql-codegen) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/105-execution/102-validation.md b/src/roadmaps/graphql/content/105-execution/102-validation.md index 0d70767ab..0e3ae420a 100644 --- a/src/roadmaps/graphql/content/105-execution/102-validation.md +++ b/src/roadmaps/graphql/content/105-execution/102-validation.md @@ -1 +1,9 @@ -# Validation \ No newline at end of file +# Validation + +In GraphQL, validation refers to the process of ensuring that a query or mutation adheres to the rules defined in the schema. This includes verifying that the query or mutation only accesses fields and types that are defined in the schema, and that the input values for fields are of the correct type and within the specified constraints. + +GraphQL servers perform validation on all incoming queries and mutations to ensure that they are valid before executing them. If a query or mutation is invalid, the server will return an error, indicating which parts of the query or mutation are invalid and why. + +Learn more from the following links: + +- [Get Started with Validation in GraphQL](https://graphql.org/learn/validation/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/105-execution/103-producing-the-result.md b/src/roadmaps/graphql/content/105-execution/103-producing-the-result.md index d9196ed44..467087ef3 100644 --- a/src/roadmaps/graphql/content/105-execution/103-producing-the-result.md +++ b/src/roadmaps/graphql/content/105-execution/103-producing-the-result.md @@ -1 +1,14 @@ -# Producing the result \ No newline at end of file +# Producing The Result + +In GraphQL, producing the result refers to the process of generating the final response to a query or mutation. This includes executing the resolvers for the selected fields, gathering the data, and formatting the response according to the requirements of the query or mutation. + +When a client sends a query or mutation to a GraphQL server, the server performs several steps to produce the result: + +- Parsing: The query or mutation is parsed and converted into an abstract syntax tree (AST) +- Validation: The query or mutation is validated against the schema to ensure that it is well-formed and adheres to the schema definition. +- Execution: The resolvers for the selected fields are executed, and the data is retrieved from the data source. +- Formatting: The data is formatted and organized into the final response, according to the requirements of the query or mutation. + +Learn more from the following links: + +- [Get Started with GraphQL](https://graphql.org/learn/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/105-execution/index.md b/src/roadmaps/graphql/content/105-execution/index.md index b0301fd3f..2b09129af 100644 --- a/src/roadmaps/graphql/content/105-execution/index.md +++ b/src/roadmaps/graphql/content/105-execution/index.md @@ -1 +1,8 @@ -# Execution \ No newline at end of file +# Execution + +In GraphQL, execution refers to the process of executing a query or mutation and returning the result to the client. The execution process includes several steps such as parsing, validation, and data retrieval, that are performed by the GraphQL engine to produce the final response to the client. + +Learn more from the following links: + +- [Get Started with Execution in GraphQL](https://graphql.org/learn/execution/) +- [Intro to Execution](https://graphql.org/graphql-js/execution/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/100-caching.md b/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/100-caching.md index 07f88797a..0f4df148d 100644 --- a/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/100-caching.md +++ b/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/100-caching.md @@ -1 +1,13 @@ -# Caching \ No newline at end of file +# Caching + +Caching is a technique that is used to improve the performance of a GraphQL server by reducing the number of requests that need to be made to the data source. It works by storing a copy of the data that has been requested by a client in a cache, and then returning that data from the cache instead of the data source when the same data is requested again. + +There are several types of caching that can be used in GraphQL: + +- Client-side caching +- Server-side caching +- CDN caching + +Learn more from the following links: + +- [Get started with Caching](https://graphql.org/learn/caching/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/101-batching.md b/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/101-batching.md index e7cf2ce39..4e5528fcb 100644 --- a/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/101-batching.md +++ b/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/101-batching.md @@ -1 +1,9 @@ -# Batching \ No newline at end of file +# Batching + +Batching in GraphQL refers to the process of sending multiple queries or mutations in a single request. This allows the client to reduce the number of round trips to the server, and can improve the performance of the application. + +There are several ways to implement batching in GraphQL: + +- Using a batching library: This approach involves using a library such as apollo-link-batch-http, which provides a way to batch multiple queries or mutations into a single request. +- Using a middleware: This approach involves using a middleware such as graphql-batch, which allows you to batch multiple queries or mutations into a single request. +- Using a serverless function: This approach involves using a serverless function such as AWS Lambda, which allows you to batch multiple queries or mutations into a single request. \ No newline at end of file diff --git a/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/102-authorization.md b/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/102-authorization.md index 02b25f227..720bbaaa1 100644 --- a/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/102-authorization.md +++ b/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/102-authorization.md @@ -1 +1,13 @@ -# Authorization \ No newline at end of file +# Authorization + +Authorization in GraphQL refers to the process of controlling access to specific fields, types, or operations in a GraphQL schema based on user roles or permissions. It allows you to restrict access to certain data or functionality in your application based on the user's role or permissions. + +There are several ways to implement authorization in GraphQL: + +- Using middleware +- Using schema directives +- Using a data source layer + +To learn more, visit the following links: + +- [Get Started with Authorization](https://graphql.org/learn/authorization/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/index.md b/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/index.md index 0c4ff9c45..40a5b2c8b 100644 --- a/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/index.md +++ b/src/roadmaps/graphql/content/106-serving-over-internet/100-graphql-over-http/index.md @@ -1 +1,9 @@ -# Graphql over http \ No newline at end of file +# GraphQL over HTTP + +GraphQL over HTTP refers to the ability to send GraphQL queries and mutations over the HTTP protocol. This allows clients to interact with a GraphQL server using the same standard HTTP methods and headers that are used for other types of web requests. + +The most common way to send GraphQL queries and mutations over HTTP is by using the **POST** method, where the query or mutation is sent in the request body as a JSON payload. The server will then execute the query or mutation and return the result in the response body. + +To learn more, visit the following links: + +- [Serving over HTTP](https://graphql.org/learn/serving-over-http/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/106-serving-over-internet/101-graphql-over-websockets/100-real-time.md b/src/roadmaps/graphql/content/106-serving-over-internet/101-graphql-over-websockets/100-real-time.md index 1262176a4..a526d4285 100644 --- a/src/roadmaps/graphql/content/106-serving-over-internet/101-graphql-over-websockets/100-real-time.md +++ b/src/roadmaps/graphql/content/106-serving-over-internet/101-graphql-over-websockets/100-real-time.md @@ -1 +1,7 @@ -# Real time \ No newline at end of file +# Real Time + +Real-time in GraphQL refers to the ability to receive real-time updates from a GraphQL server. This allows clients to receive updates from the server as soon as they occur, rather than having to periodically poll the server for new data. + +Learn more from the following links: + +- [Get Started with Real Time with GraphQL](https://the-guild.dev/blog/subscriptions-and-live-queries-real-time-with-graphql) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/106-serving-over-internet/101-graphql-over-websockets/101-authorization.md b/src/roadmaps/graphql/content/106-serving-over-internet/101-graphql-over-websockets/101-authorization.md index 02b25f227..720bbaaa1 100644 --- a/src/roadmaps/graphql/content/106-serving-over-internet/101-graphql-over-websockets/101-authorization.md +++ b/src/roadmaps/graphql/content/106-serving-over-internet/101-graphql-over-websockets/101-authorization.md @@ -1 +1,13 @@ -# Authorization \ No newline at end of file +# Authorization + +Authorization in GraphQL refers to the process of controlling access to specific fields, types, or operations in a GraphQL schema based on user roles or permissions. It allows you to restrict access to certain data or functionality in your application based on the user's role or permissions. + +There are several ways to implement authorization in GraphQL: + +- Using middleware +- Using schema directives +- Using a data source layer + +To learn more, visit the following links: + +- [Get Started with Authorization](https://graphql.org/learn/authorization/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/106-serving-over-internet/101-graphql-over-websockets/index.md b/src/roadmaps/graphql/content/106-serving-over-internet/101-graphql-over-websockets/index.md index b3a413b86..c95f97bf4 100644 --- a/src/roadmaps/graphql/content/106-serving-over-internet/101-graphql-over-websockets/index.md +++ b/src/roadmaps/graphql/content/106-serving-over-internet/101-graphql-over-websockets/index.md @@ -1 +1,7 @@ -# Graphql over websockets \ No newline at end of file +# GraphQL Over Websockets + +The WebSocket API is an advanced technology that makes it possible to open a two-way interactive communication session between the user's browser and a server. With this API, you can send messages to a server and receive event-driven responses without having to poll the server for a reply. + +Learn more from the following links: + +- [GraphQL over WebSockets](https://the-guild.dev/blog/graphql-over-websockets) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/106-serving-over-internet/102-graphql-over-sse/100-authorization.md b/src/roadmaps/graphql/content/106-serving-over-internet/102-graphql-over-sse/100-authorization.md index 02b25f227..720bbaaa1 100644 --- a/src/roadmaps/graphql/content/106-serving-over-internet/102-graphql-over-sse/100-authorization.md +++ b/src/roadmaps/graphql/content/106-serving-over-internet/102-graphql-over-sse/100-authorization.md @@ -1 +1,13 @@ -# Authorization \ No newline at end of file +# Authorization + +Authorization in GraphQL refers to the process of controlling access to specific fields, types, or operations in a GraphQL schema based on user roles or permissions. It allows you to restrict access to certain data or functionality in your application based on the user's role or permissions. + +There are several ways to implement authorization in GraphQL: + +- Using middleware +- Using schema directives +- Using a data source layer + +To learn more, visit the following links: + +- [Get Started with Authorization](https://graphql.org/learn/authorization/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/106-serving-over-internet/102-graphql-over-sse/index.md b/src/roadmaps/graphql/content/106-serving-over-internet/102-graphql-over-sse/index.md index 8ad883ce9..23a6cbd3e 100644 --- a/src/roadmaps/graphql/content/106-serving-over-internet/102-graphql-over-sse/index.md +++ b/src/roadmaps/graphql/content/106-serving-over-internet/102-graphql-over-sse/index.md @@ -1 +1,11 @@ -# Graphql over sse \ No newline at end of file +# GraphQL Over SSE + +GraphQL over SSE (Server-Sent Events) is a way to use the Server-Sent Events (SSE) protocol to send real-time updates from the server to the client over a single HTTP connection. + +SSE is a simple and efficient protocol for sending real-time updates from the server to the client over a single HTTP connection. It's supported by most modern web browsers and it's easy to implement on the server side. + +To implement GraphQL over SSE, you can use a library such as graphql-sse which provides a way to send GraphQL updates over SSE. This library allows you to handle SSE connections and events, and to send and receive GraphQL updates over the SSE connection. + +To learn more, visit the following links: + +- [Overview of GraphQL over SSE (Server-Sent Events)](https://the-guild.dev/blog/graphql-over-sse) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/106-serving-over-internet/index.md b/src/roadmaps/graphql/content/106-serving-over-internet/index.md index a8c01d875..90cce731f 100644 --- a/src/roadmaps/graphql/content/106-serving-over-internet/index.md +++ b/src/roadmaps/graphql/content/106-serving-over-internet/index.md @@ -1 +1,13 @@ -# Serving over internet \ No newline at end of file +# Serving Over Internet + +Serving GraphQL over the internet refers to the process of making a GraphQL server available to clients over the internet, typically by exposing the server's endpoint through a public IP address or a domain name. + +There are several ways to serve a GraphQL server over the internet: + +- Using a reverse proxy +- Using a cloud service +- Using a serverless function + +To learn more, visit the following links: + +- [Introduction to Serving over HTTPs](https://graphql.org/learn/serving-over-http/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/107-pagination.md b/src/roadmaps/graphql/content/107-pagination.md index 4122fb7da..c309c61bf 100644 --- a/src/roadmaps/graphql/content/107-pagination.md +++ b/src/roadmaps/graphql/content/107-pagination.md @@ -1 +1,13 @@ -# Pagination \ No newline at end of file +# Pagination + +Pagination in GraphQL refers to the process of breaking up large sets of data into smaller chunks, also known as pages, and providing a way to navigate between these pages. This allows clients to retrieve a specific subset of data, rather than having to retrieve all of the data at once, which can be beneficial for performance, especially when working with large datasets. + +There are several ways to implement pagination in GraphQL: + +- Cursor-based pagination +- Offset-based pagination +- Relay-style pagination + +To learn more, visit the following links: + +- [Get Started with Pagination](https://graphql.org/learn/pagination/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/108-frontend-implementations/100-relay.md b/src/roadmaps/graphql/content/108-frontend-implementations/100-relay.md index c6cc93bbf..fa6200ff5 100644 --- a/src/roadmaps/graphql/content/108-frontend-implementations/100-relay.md +++ b/src/roadmaps/graphql/content/108-frontend-implementations/100-relay.md @@ -1 +1,9 @@ -# Relay \ No newline at end of file +# Relay + +Relay is a JavaScript framework that was developed by Facebook to build data-driven applications using GraphQL. It provides a set of tools and conventions that make it easier to build efficient and scalable applications that use GraphQL. + +Relay is designed to work with GraphQL on the server and provides a set of client-side libraries for building client applications. It provides a set of components and hooks that make it easy to build efficient and scalable applications. + +Learn more from the following links: + +- [GraphQL Code Generator & Relay Compiler](https://the-guild.dev/blog/graphql-codegen-relay-compiler) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/108-frontend-implementations/101-apollo-client.md b/src/roadmaps/graphql/content/108-frontend-implementations/101-apollo-client.md index 39a68c9cb..d82822f4c 100644 --- a/src/roadmaps/graphql/content/108-frontend-implementations/101-apollo-client.md +++ b/src/roadmaps/graphql/content/108-frontend-implementations/101-apollo-client.md @@ -1 +1,9 @@ -# Apollo client \ No newline at end of file +# Apollo Client + +Apollo Client is a popular JavaScript library for building client applications that consume GraphQL APIs. It is developed and maintained by the Apollo team and is widely used in the industry. + +Apollo Client provides a set of features that make it easy to interact with a GraphQL server, such as querying, mutating, and subscribing to data. It also provides a caching system to store the results of previous queries, which improves the performance of the application. + +Learn more from the following links: + +- [Why Apollo Client - Frontend?](https://www.howtographql.com/react-apollo/0-introduction/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/108-frontend-implementations/102-urql.md b/src/roadmaps/graphql/content/108-frontend-implementations/102-urql.md index c7d928b90..6bad28c1a 100644 --- a/src/roadmaps/graphql/content/108-frontend-implementations/102-urql.md +++ b/src/roadmaps/graphql/content/108-frontend-implementations/102-urql.md @@ -1 +1,3 @@ -# Urql \ No newline at end of file +# URQL + +URQL is a highly customizable and versatile GraphQL client with which you add on features like normalized caching as you grow. It's built to be both easy to use for newcomers to GraphQL, and extensible, to grow to support dynamic single-app applications and highly customized GraphQL infrastructure. \ No newline at end of file diff --git a/src/roadmaps/graphql/content/108-frontend-implementations/index.md b/src/roadmaps/graphql/content/108-frontend-implementations/index.md index 97a69d8f2..fe5338430 100644 --- a/src/roadmaps/graphql/content/108-frontend-implementations/index.md +++ b/src/roadmaps/graphql/content/108-frontend-implementations/index.md @@ -1 +1,10 @@ -# Frontend implementations \ No newline at end of file +# Frontend Implementations + +In GraphQL, the frontend refers to the client-side of the application, typically the web or mobile app that the end-user interacts with. + +When using GraphQL on the frontend, developers can use a GraphQL client library, such as Apollo Client or Relay, to interact with the GraphQL server. These libraries provide a way to easily send GraphQL queries and mutations to the server and handle the response. + + +Learn more from the following links: + +- [Guide to GraphQL for Front-End Developers](https://www.howtographql.com/react-apollo/0-introduction/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/109-backend-implementations/100-graphql-http.md b/src/roadmaps/graphql/content/109-backend-implementations/100-graphql-http.md index 1edaa4a53..366a905b5 100644 --- a/src/roadmaps/graphql/content/109-backend-implementations/100-graphql-http.md +++ b/src/roadmaps/graphql/content/109-backend-implementations/100-graphql-http.md @@ -1 +1,13 @@ -# Graphql http \ No newline at end of file +# GraphQL HTTP + +GraphQL HTTP is a specification for serving GraphQL over HTTP. It defines a standard way of sending GraphQL queries and mutations over the HTTP protocol, and it is widely supported by GraphQL servers and clients. + +The GraphQL HTTP specification defines two main HTTP methods: + +- **POST:** Used to send queries and mutations to the server. The query or mutation is sent in the request body as a JSON payload, and the server returns the result in the response body. +- **GET:** Used to send queries to the server, but it's not recommended to use GET for queries because it's not as efficient as POST method. + +Learn more from the following links: + +- [Overview of GraphQL HTTP](https://graphql.org/graphql-js/express-graphql/#graphqlhttp) +- [Get Started with GraphQL HTTP](https://graphql.org/learn/serving-over-http/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/109-backend-implementations/101-graphql-yoga.md b/src/roadmaps/graphql/content/109-backend-implementations/101-graphql-yoga.md index 5701df9be..a742c84d8 100644 --- a/src/roadmaps/graphql/content/109-backend-implementations/101-graphql-yoga.md +++ b/src/roadmaps/graphql/content/109-backend-implementations/101-graphql-yoga.md @@ -1 +1,9 @@ -# Graphql yoga \ No newline at end of file +# GraphQL Yoga + +GraphQL Yoga is a popular open-source GraphQL server library for Node.js. It is built on top of the popular Express.js web framework and provides a simple and flexible way to build GraphQL servers with minimal boilerplate code. + +One of the key features of GraphQL Yoga is that it provides a set of built-in functionality that makes it easy to handle common tasks such as authentication, authorization, and data validation. It also provides support for subscriptions, which allow clients to receive real-time updates from the server. + +Learn more from the following links: + +- [GraphQL Armor - for Yoga Server 2](https://the-guild.dev/blog/improved-security-with-graphql-armor-support-for-yoga-server-2) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/109-backend-implementations/102-apollo-server.md b/src/roadmaps/graphql/content/109-backend-implementations/102-apollo-server.md index 752088142..e47ddef94 100644 --- a/src/roadmaps/graphql/content/109-backend-implementations/102-apollo-server.md +++ b/src/roadmaps/graphql/content/109-backend-implementations/102-apollo-server.md @@ -1 +1,9 @@ -# Apollo server \ No newline at end of file +# Apollo Server + +Apollo Server is a popular open-source library for building GraphQL servers in JavaScript. It provides a simple and flexible way to build GraphQL servers by providing a set of tools and features for handling common tasks such as parsing and validating queries, executing resolvers, and formatting responses. + +One of the key features of Apollo Server is that it provides a set of built-in functionality that makes it easy to handle common tasks such as authentication, authorization, and data validation. It also provides support for subscriptions, which allow clients to receive real-time updates from the server. + +Learn more from the following links: + +- [Apollo Tutorial - Introduction](https://www.howtographql.com/react-apollo/0-introduction/) \ No newline at end of file diff --git a/src/roadmaps/graphql/content/109-backend-implementations/103-mercurius.md b/src/roadmaps/graphql/content/109-backend-implementations/103-mercurius.md index 27888829f..b4b84e08b 100644 --- a/src/roadmaps/graphql/content/109-backend-implementations/103-mercurius.md +++ b/src/roadmaps/graphql/content/109-backend-implementations/103-mercurius.md @@ -1 +1,5 @@ -# Mercurius \ No newline at end of file +# Mercurius + +Mercurius is an open-source library for building real-time GraphQL servers in Node.js. It provides a simple and flexible way to build GraphQL servers by providing a set of tools and features for handling real-time subscriptions. + +One of the key features of Mercurius is that it is built on top of the popular WebSockets protocol and it allows the client to subscribe to real-time updates from the server. It also supports batching and caching of queries and mutations, which allows for efficient and fast data transfer between the client and server. \ No newline at end of file diff --git a/src/roadmaps/graphql/content/109-backend-implementations/index.md b/src/roadmaps/graphql/content/109-backend-implementations/index.md index b858fa06c..2e89c23b7 100644 --- a/src/roadmaps/graphql/content/109-backend-implementations/index.md +++ b/src/roadmaps/graphql/content/109-backend-implementations/index.md @@ -1 +1,12 @@ -# Backend implementations \ No newline at end of file +# Backend Implementations + +There are several ways to implement a GraphQL backend, depending on the use case, the technology stack, and the complexity of the application. The most common ways to implement a GraphQL backend are: + +- Building a custom GraphQL server +- Using a GraphQL backend-as-a-service +- Wrapping a REST API with a GraphQL layer +- Using a microservices architecture + +Learn more from the following links: + +- [How to use GraphQL to build Backend?](https://www.howtographql.com/typescript-apollo/0-introduction/) \ No newline at end of file