Skip to content
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

Update Learn introduction page. #1799

Merged
merged 6 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/globals.css
Original file line number Diff line number Diff line change
Expand Up @@ -486,3 +486,12 @@ div[id^="headlessui-menu-items"] {
font-size: 13px;
padding: 7px 14px;
}

.learn-subtitle {
@apply mt-2;
@apply pb-2;
@apply border-neutral-200;
@apply border-b;
Comment on lines +493 to +494
Copy link
Contributor

Choose a reason for hiding this comment

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

border color should be improved on dark mode
image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Border color for dark mode has been adjusted.

Screenshot 2024-10-29 at 2 51 01 PM

@apply text-xl;
@apply dark:border-neutral-700/80;
}
82 changes: 64 additions & 18 deletions src/pages/learn/index.mdx
Original file line number Diff line number Diff line change
@@ -1,42 +1,46 @@
import { Callout } from "nextra/components"

# Introduction to GraphQL

> Learn about GraphQL, how it works, and how to use it. Looking for documentation on how to build a GraphQL service?
> There are libraries to help you implement GraphQL in [many different languages](/code). For an in-depth learning experience
> with practical tutorials, see [the available training courses](/community/resources/training-courses).
<p className="learn-subtitle">Learn about GraphQL, how it works, and how to use it</p>

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. The [GraphQL specification](https://spec.graphql.org/) was open-sourced in 2015 and has since been implemented in a variety of programming languages. GraphQL isn't tied to any specific database or storage engine—it is backed by your existing code and data.

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.
<Callout type="info">If you're already familiar with GraphQL and would like to read documentation on how to build a GraphQL service, then there are libraries to help you implement GraphQL in [many different languages](/community/tools-and-libraries/?tags=server). There are also many libraries available that allow [client applications to query existing GraphQL APIs](/community/tools-and-libraries/?tags=client).</Callout>
Copy link
Member

Choose a reason for hiding this comment

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

Should we mention about GraphQL.js being the official reference implementation maintained by the GraphQL foundation?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@benjie Do you want to call out graphql.js specifically here?

Copy link
Member

Choose a reason for hiding this comment

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

I don't think we need to do that here, but our first mention of a "reference implementation" should hyperlink to GraphQL.js


A GraphQL service is created by defining types and fields on those types, then providing functions for each field on each type.
For example, a GraphQL service that tells you who the logged in user is (`me`) as well as that user's name might look
like this:
## Describe your API with a type system

A GraphQL service is created by [defining types and their fields](/learn/schema/), and then writing a function for each field to [provide the required data](/learn/execution/). For example, a GraphQL service that tells you the name of a logged-in user might look like this:

```graphql
type Query {
me: User
}

type User {
id: ID
name: String
}
```

Along with functions for each field on each type:

```js
function Query_me(request) {
return request.auth.user
// Provide data for the `me` field on the `Query` type
function Query_me(query, args, context, info) {
return context.request.auth.user
}

function User_name(user) {
return user.getName()
// Provide data for the `name` field on the `User` type
function User_name(user, args, context, info) {
return context.db.getUserFullName(user.id)
}
```

After a GraphQL service is running (typically at a URL on a web service), it can receive GraphQL queries to validate and execute.
The service first checks a query to ensure it only refers to the types and fields defined, and then runs the provided functions
to produce a result.
In the example above, the function that provides data for the `me` field on the `Query` type uses information about the authenticated user who made the request, while the the `name` field on the `User` type is populated by using that user's ID to fetch their full name from a database.

## Query exactly what you need

After a GraphQL service is running (typically at a URL on a web service), it can receive [GraphQL queries](/learn/queries/) to validate and execute from clients. The service first checks a query to ensure it only refers to the types and fields defined for the API and then runs the provided functions to produce a result.

For example, the query:

Expand All @@ -52,8 +56,50 @@ Could produce the following JSON result:

```json
{
"me": {
"name": "Luke Skywalker"
"data": {
"me": {
"name": "Luke Skywalker"
}
}
}
```

With even a simple query, we can see some of the key features that make GraphQL so powerful. The client can make queries to the API that mirror the structure of the data that they need and then receive just that data in the expected shape with a single request—and without having to worry about which underlying data sources provided it.

## Evolve your API without versioning

Client requirements change over time and GraphQL allows your API to evolve in response to those needs and without the overhead of managing different API versions. For example, if a new feature calls for more specific name values to be available, then the `User` type could be updated as follows:

```graphql
type User {
fullName: String
nickname: String
name: String @deprecated(reason: "Use `fullName`.")
}
```

Client tooling will encourage developers to use the new fields and remove usage of the deprecated `name` field. The field can be removed once it is determined it is no longer used; in the meantime GraphQL will continue to provide its data as expected.

## Try it out!

The best way to learn GraphQL is to start writing queries. The query editors used throughout this guide are **interactive**, so try adding an `id` and `appearsIn` fields to the `hero` object to see an updated result:

```graphql
# { "graphiql": true }
{
hero {
name
# add additional fields here!
}
}
```

<Callout type="info">
The examples in this guide are based on [a modified version of the SWAPI GraphQL schema](https://github.com/graphql/graphql.github.io/blob/source/src/components/marked/swapi-schema.tsx). Because these queries are designed for illustrative purposes, they will not run on the full version of the SWAPI GraphQL API due to differences between the two schemas. [You can try the full version of the API here.](https://graphql.org/swapi-graphql/)
</Callout>

## Next steps

Now that you know some key GraphQL concepts, you're ready to learn about all of the different aspects of its [type system](/schema/).

For an in-depth learning experience with practical tutorials, see [the available training courses](/community/resources/training-courses).