Package org.brapi.schematools.core.graphql

Class GraphQLGenerator

java.lang.Object

org.brapi.schematools.core.graphql.GraphQLGenerator

public class GraphQLGenerator
extends Object

Generates a GraphQL schema from a BrAPI Json Schema.

Constructor Summary

Constructors

Constructor	Description
GraphQLGenerator()	Creates a GraphQLGenerator using a default BrAPISchemaReader and the default GraphQLGeneratorOptions.
GraphQLGenerator(GraphQLGeneratorOptions options)	Creates a GraphQLGenerator using a default BrAPISchemaReader and the provided GraphQLGeneratorOptions.

Method Summary

Modifier and Type	Method	Description
Response<graphql.schema.GraphQLSchema>	generate(Path schemaDirectory)	Generates the GraphQLSchema from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.
Response<graphql.schema.GraphQLSchema>	generate(Path schemaDirectory, GraphQLGeneratorMetadata metadata)	Generates the GraphQLSchema from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GraphQLGenerator

public GraphQLGenerator()

Creates a GraphQLGenerator using a default BrAPISchemaReader and the default GraphQLGeneratorOptions.

GraphQLGenerator

public GraphQLGenerator(GraphQLGeneratorOptions options)

Creates a GraphQLGenerator using a default BrAPISchemaReader and the provided GraphQLGeneratorOptions.

Parameters:

options - The options to be used in the generation.

Method Details

generate

public Response<graphql.schema.GraphQLSchema> generate(Path schemaDirectory)

Generates the GraphQLSchema from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.

Parameters:

schemaDirectory - the path to the complete BrAPI Specification

Returns:

the GraphQLSchema from the complete BrAPI Specification

generate

public Response<graphql.schema.GraphQLSchema> generate(Path schemaDirectory,
 GraphQLGeneratorMetadata metadata)

Generates the GraphQLSchema from the complete BrAPI Specification in a directory contains a subdirectories for each module that contain the BrAPI Json schema and the additional subdirectories called 'Requests' that contains the request schemas and BrAPI-Common that contains common schemas for use across modules.

Parameters:

schemaDirectory - the path to the complete BrAPI Specification

metadata - additional metadata that is used in the generation

Returns:

the GraphQLSchema from the complete BrAPI Specification