com.expediagroup.graphql.generator.federation.toFederatedSchema.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graphql-kotlin-federation Show documentation

Federated GraphQL schema generator

There is a newer version: 8.2.1

Show newest version

/*
 * Copyright 2022 Expedia, Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.expediagroup.graphql.generator.federation

import com.expediagroup.graphql.generator.TopLevelObject
import com.expediagroup.graphql.generator.exceptions.GraphQLKotlinException
import graphql.schema.GraphQLSchema

/**
 * Entry point to generate federated graphql schema using reflection on the passed objects.
 *
 * @param config federated schema generation configuration
 * @param queries optional list of [TopLevelObject] to use for GraphQL queries
 * @param mutations optional list of [TopLevelObject] to use for GraphQL mutations
 * @param subscriptions optional list of [TopLevelObject] to use for GraphQL subscriptions
 * @param schemaObject optional [TopLevelObject] reference to the annotated schema class
 *
 * @return GraphQLSchema from graphql-java
 */
@Throws(GraphQLKotlinException::class)
fun toFederatedSchema(
    config: FederatedSchemaGeneratorConfig,
    queries: List = emptyList(),
    mutations: List = emptyList(),
    subscriptions: List = emptyList(),
    schemaObject: TopLevelObject? = null
): GraphQLSchema {
    val generator = FederatedSchemaGenerator(config)
    return generator.use {
        it.generateSchema(
            queries = queries,
            mutations = mutations,
            subscriptions = subscriptions,
            schemaObject = schemaObject
        )
    }
}