Как использовать GraphQL API в October CMS?

@shirley.vonrueden 

Чтобы использовать GraphQL API в October CMS, вам нужно выполнить следующие шаги:

1. Установите плагин condegraca/graphql с помощью Composer, выполнив команду composer require condegraca/graphql.
2. Включите плагин. Для этого добавьте в config/app.php следующую строку: 'CondegracaGraphQLGraphQLServiceProvider',
3. Создайте файл схемы GraphQL, определяющий ваш API. Он может называться, например, schema.graphql и располагаться в каталоге plugins/yourplugin/graphql/. В этом файле вы будете определять типы данных, запросы и мутации, доступные в вашем API.
4. Создайте классы-резолверы для ваших запросов и мутаций. Эти классы будут содержать логику для получения и обработки данных, запрошенных через GraphQL API. Классы-резолверы должны наследоваться от базового класса CondegracaGraphQLResolversResolver. Они могут быть размещены в каталоге plugins/yourplugin/graphql/. Пример класса-резолвера: use CondegracaGraphQLResolversResolver; class UsersResolver extends Resolver { public function resolve() { // Логика для получения и обработки данных } }
5. Зарегистрируйте ваши классы-резолверы в файле config/graphql/resolvers.php. Пример регистрации: return [ 'Query' => [ 'users' => 'YourPluginNamespaceUsersResolver', ], ];
6. Маршрутизируйте запросы к plugins/graphql добавлением следующего кода в routes.php вашего плагина или в файл routes.php в корневом каталоге проекта October CMS: Route::match(['GET', 'POST'], 'graphql', 'CondegracaGraphQLGraphQLController@query');

После выполнения этих шагов вы сможете отправлять GraphQL запросы на http://yourwebsite.com/plugins/graphql.

@shirley.vonrueden 

Для использования GraphQL API в October CMS, вам потребуется установить GraphQL плагин. Вы можете найти его в официальном магазине плагинов October CMS или установить его с помощью Composer.

После установки плагина, вам необходимо создать схему GraphQL, которая определит доступные запросы и типы данных. Вы можете создать файл с расширением .graphql в папке plugins/ваш_плагин/graphql/schema и определить схему GraphQL с помощью языка схем (Schema Definition Language) GraphQL.

Например, вам нужно определить тип данных 'User' и запрос 'getUser'. Вы можете создать файл schema.graphql с содержимым:

1
2
3
4
5
6
7
8
9

type User {
  id: ID!
  name: String!
  email: String!
}

type Query {
  getUser(id: ID!): User!
}

Затем, вам необходимо зарегистрировать свою схему GraphQL в October CMS. В вашем плагине создайте класс, наследующий класс SystemClassesPluginBase. В этом классе переопределите метод registerGraphqlSchemas(), чтобы зарегистрировать вашу схему:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

use GraphQL;
use SystemClassesPluginBase;

class YourPlugin extends PluginBase
{
    public function registerGraphqlSchemas()
    {
        return [
            'your-plugin' => [
                'path' => 'plugins/your-plugin/graphql/schema.graphql',
            ],
        ];
    }
}

Теперь вы можете использовать GraphQL API, отправляя POST запросы на URL http://your-october-cms-url/graphql со следующими заголовками:

1
2

Content-Type: application/json
Accept: application/json

Пример запроса на получение пользователя с id=1:

1
2
3
4
5
6
7
8
9

{
  "query": "query {
    getUser(id: 1) {
      id
      name
      email
    }
  }"
}

Пример ответа:

1
2
3
4
5
6
7
8
9

{
  "data": {
    "getUser": {
      "id": "1",
      "name": "John Doe",
      "email": "[email protected]"
    }
  }
}

Это лишь базовый пример использования GraphQL API в October CMS. Вы можете создавать свои собственные типы данных, запросы и мутации, чтобы адаптировать API под свои нужды.