Структурирование проекта Express + GraphQL

Question

Как вы поддерживаете GraphQL API аккуратно?

У меня есть эта простая конечная точка с тремя запрашиваемыми типами, и я сохраняю аккуратную структуру папок, например:

/api
  |--/entry
      |--/types.js
      |--/queries.js
      |--/mutations.js
  |--/category
      |--/types.js
      |--/queries.js
      |--/mutations.js
  |--/service
      |--/types.js
      |--/queries.js
      |--/mutations.js
  |--index.js

index.js - это место, где я определяю свою корневую мутацию и запрос, что требует от меня явной ссылки на мои типы, запросы и мутации, поэтому очевидно, что этот файл будет расти по мере добавления новых типов, что своего рода побеждает точку разделения они в разных папках в первую очередь.

// src/routes/api/index.js

const LOGGER = require('../../logger')('routes/api');
const EXPRESS_GRAPHQL = require('express-graphql');

// returned when requiring this module
const routes = function (handler) {

    LOGGER.log('info', 'Setting up api routes.');

    const {
        GraphQLSchema,
        GraphQLObjectType,
    } = require('graphql');

    const categoryQuery = require('./category/queries');
    const {
        updateCategory,
        deleteCategory,
        createCategory
    } = require('./category/mutations');

    const serviceQuery = require('./service/queries');
    const {
        updateService,
        deleteService,
        createService
    } = require('./service/mutations');

    const entryQuery = require('./entry/queries');
    const {
        updateEntry,
        deleteEntry,
        createEntry
    } = require('./entry/mutations');

    const RootQuery = new GraphQLObjectType({
        name: 'rootQuery',
        description: 'This is the root query which holds all possible READ entrypoints for the GraphQL API',
        fields: () => ({
            service: serviceQuery,
            category: categoryQuery,
            entry: entryQuery
        })
    });

    const RootMutation = new GraphQLObjectType({
        name: 'rootMutation',
        description: 'This is the root mutation which holds all possible WRITE entrypoints for the GraphQL API',
        fields: () => ({
            updateCategory,
            deleteCategory,
            createCategory,
            updateEntry,
            deleteEntry,
            createEntry,
            updateService,
            deleteService,
            createService
        })
    });

    const Schema = new GraphQLSchema({
        query: RootQuery,
        mutation: RootMutation
    });

    return EXPRESS_GRAPHQL({
        schema: Schema,
        pretty: true,
        graphiql: true,
    });
};

module.exports = routes;

Как мне этого избежать?

Answer 1

Ну, это совсем не противоречит цели - у вас есть хорошо разделенные проблемы в вашем приложении, и единственная причина роста index.js - это требование явно требовать все ваши модули.

Мы боролись с подобной проблемой и в итоге установили строгий интерфейс для того, что должно содержаться в каждом каталоге модели (entry/, category/, service/) и что модули должны экспортировать. Благодаря этому вы можете написать аккуратную функцию-обертку, которая динамически перечисляет все каталоги моделей при запуске и пытается загрузить их, ожидая указанного интерфейса. Благодаря этому вам совсем не нужно писать новый код на index.js. Вы просто копируете каталог, внедряете экспортированные функции, и они автоматически загружаются при запуске приложения.

Не забудьте добавить красивую регистрацию ошибок в ваш загрузчик, чтобы избежать загадочных ошибок, когда вы случайно нарушаете контракт интерфейса.