Документация / GraphQL

Схема примеров

Примеры этой документации, как и оригинального руководства graphql.org, построены на изменённой версии схемы SWAPI GraphQL о вселенной «Звёздных войн». Ниже — её полная версия с переведёнными описаниями. Откройте её в редакторе кнопкой «Открыть в редакторе», чтобы увидеть карту типов: интерфейс Character и его реализации Human и Droid, объединение SearchResult, соединение FriendsConnection для пагинации.

schema {
  query: Query
  mutation: Mutation
}

"Тип запросов — все точки входа в граф объектов"
type Query {
  hero(episode: Episode): Character
  reviews(episode: Episode!): [Review]
  search(text: String): [SearchResult]
  character(id: ID!): Character
  droid(id: ID!): Droid
  human(id: ID!): Human
  starship(id: ID!): Starship
}

"Тип изменений — всё, что можно изменить в данных"
type Mutation {
  createReview(episode: Episode, review: ReviewInput!): Review
  rateFilm(episode: Episode!, rating: FilmRating!): Film
  updateHumanName(id: ID!, name: String!): Human
  deleteStarship(id: ID!): ID
}

"Эпизоды трилогии «Звёздные войны»"
enum Episode {
  "Эпизод IV: Новая надежда, 1977 год."
  NEWHOPE

  "Эпизод V: Империя наносит ответный удар, 1980 год."
  EMPIRE

  "Эпизод VI: Возвращение джедая, 1983 год."
  JEDI
}

"Личная оценка эпизода «Звёздных войн»"
enum FilmRating {
  "Отрицательная оценка"
  THUMBS_DOWN

  "Положительная оценка"
  THUMBS_UP
}

"Фильм трилогии «Звёздные войны»"
type Film {
  "Эпизод «Звёздных войн», показанный в фильме"
  episode: Episode!

  "Оценка фильма текущим пользователем"
  viewerRating: FilmRating
}

"Персонаж вселенной «Звёздных войн»"
interface Character {
  "Идентификатор персонажа"
  id: ID!

  "Имя персонажа"
  name: String!

  "Друзья персонажа; пустой список, если друзей нет"
  friends: [Character]

  "Друзья персонажа в виде соединения с рёбрами"
  friendsConnection(first: Int, after: ID): FriendsConnection!

  "Фильмы, в которых появляется персонаж"
  appearsIn: [Episode]!
}

"Единицы длины"
enum LengthUnit {
  "Стандартная единица в большинстве стран"
  METER

  "Используется в основном в США"
  FOOT
}

"Человекоподобное существо вселенной «Звёздных войн»"
type Human implements Character {
  "Идентификатор человека"
  id: ID!

  "Как этот человек называет себя"
  name: String!

  "Рост в выбранных единицах, по умолчанию — в метрах"
  height(unit: LengthUnit = METER): Float

  "Масса в килограммах; null, если неизвестна"
  mass: Float

  "Друзья этого человека; пустой список, если друзей нет"
  friends: [Character]

  "Друзья человека в виде соединения с рёбрами"
  friendsConnection(first: Int, after: ID): FriendsConnection!

  "Фильмы, в которых появляется человек"
  appearsIn: [Episode]!

  "Корабли, которыми управлял этот персонаж; пустой список, если таких нет"
  starships: [Starship]
}

"Автономный механический персонаж вселенной «Звёздных войн»"
type Droid implements Character {
  "Идентификатор дроида"
  id: ID!

  "Как этого дроида называют другие"
  name: String!

  "Друзья этого дроида; пустой список, если друзей нет"
  friends: [Character]

  "Друзья дроида в виде соединения с рёбрами"
  friendsConnection(first: Int, after: ID): FriendsConnection!

  "Фильмы, в которых появляется дроид"
  appearsIn: [Episode]!

  "Основная функция дроида"
  primaryFunction: String
}

"Соединение с друзьями персонажа"
type FriendsConnection {
  "Общее число друзей"
  totalCount: Int

  "Рёбра — по одному на каждого друга персонажа."
  edges: [FriendsEdge]

  "Список друзей — для удобства, когда рёбра не нужны."
  friends: [Character]

  "Сведения для пагинации этого соединения"
  pageInfo: PageInfo!
}

"Ребро соединения с друзьями персонажа"
type FriendsEdge {
  "Курсор для пагинации"
  cursor: ID!

  "Персонаж на конце этого ребра дружбы"
  node: Character
}

"Сведения для пагинации этого соединения"
type PageInfo {
  startCursor: ID
  endCursor: ID
  hasNextPage: Boolean!
}

"Отзыв о фильме"
type Review {
  "Число звёзд в отзыве, от 1 до 5"
  stars: Int!

  "Комментарий о фильме"
  commentary: String
}

"Входной объект для создания нового отзыва"
input ReviewInput {
  "От 0 до 5 звёзд"
  stars: Int!

  "Комментарий о фильме, необязательный"
  commentary: String
}

"Космический корабль"
type Starship {
  "Идентификатор корабля"
  id: ID!

  "Название корабля"
  name: String!

  "Длина корабля по самой длинной оси"
  length(unit: LengthUnit = METER): Float
}

"Результат поиска: человек, дроид или корабль"
union SearchResult = Human | Droid | Starship

Что посмотреть на карте

  • Корень Query — точки входа: hero, search, character, droid, human, starship, reviews. Выберите корень Mutation в панели «Описание», чтобы увидеть изменения.
  • Интерфейс Character — пунктирные стрелки ведут к нему от Human и Droid.
  • Объединение SearchResult — точечные стрелки ведут к Human, Droid и Starship.
  • FriendsConnection — с галочкой «Свернуть Relay» поле friendsConnection показано как список персонажей; снимите галочку, чтобы увидеть FriendsConnection, FriendsEdge и PageInfo.
  • Входной тип ReviewInput на карте не показан — щёлкните по типу аргумента createReview, чтобы открыть его описание.

Карточки можно перетаскивать мышью, чтобы расположить схему удобнее; кнопка «Расставить автоматически» вернёт автоматическую раскладку.

Данные примеров

В демонстрационных данных пять людей (Luke Skywalker — 1000, Darth Vader — 1001, Han Solo — 1002, Leia Organa — 1003, Wilhuff Tarkin — 1004), два дроида (C-3PO — 2000, R2-D2 — 2001) и четыре корабля (Millenium Falcon — 3000, X-Wing — 3001, TIE Advanced x1 — 3002, Imperial shuttle — 3003). Поле hero возвращает Люка для эпизода EMPIRE и R2-D2 для остальных.

Обновлено: 17 октября 2026 г.