graphql-spring-annotations

KO | EN

gitlite — search

#react #typescript #rust #linux #docker #macos #nodejs #java #windows #awesome #cli #awesome-list #vue #open-source

graphql-spring-annotations

(★ 12)

a starter for a graphql-java-annotations in spring

graphql-spring-annotations 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# graphql-spring-annotations
[ ![Download](https://api.bintray.com/packages/yarinvak/graphql-spring-annotations/graphql-spring-annotations/images/download.svg) ](https://bintray.com/yarinvak/graphql-spring-annotations/graphql-spring-annotations/_latestVersion)
[![Build Status](https://travis-ci.com/yarinvak/graphql-spring-annotations.svg?branch=master)](https://travis-ci.com/yarinvak/graphql-spring-annotations)

[graphql-java-annotations](https://github.com/Enigmatis/graphql-java-annotations) is a great library for creating a graphql schema based on POJOs and java annotations.
It simplifies the graphql schema creation and does not require creating a separated graphql schema and java types.

graphql-spring-annotations is based on [graphql-java-annotations](https://github.com/Enigmatis/graphql-java-annotations) and [graphql-spring-boot](https://github.com/graphql-java-kickstart/graphql-spring-boot), and let
you create a spring server for you graphql application, using spring annotations to create your schema.

## How to use

first, add the following dependecies to your build.gradle:

```$xslt
dependencies {
    compile "io.github.enigmatis:graphql-spring-annotations:0.1.5"
}
```

Then, create your main ``Application`` class:

```java
package myAppPckg;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication(scanBasePackages = {"springAnno",
"myAppPckg"})
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
```

Notice that in your ``scanBasePackages`` you must supply `springAnno` package, which comes from the ``graphql-spring-boot`` project.
You also have to scan your package if it contains spring components.

Now you have to create your schema types.

Lets begin with the Query type definition (via graphql-java-annotations syntax):

```java
@Component
public class Query implements QueryRoot {
     @GraphQLField
     @GraphQLInvokeDetached
     public String helloWorld(){
         return "helloWorld";
     }   
}
```

This is a standard type definition using graphql-java-annotations syntax. The only difference is that we add the `@Component` annotation,
and implement `QueryRoot` interface (then it will be injected automatically into the schema).

You can create your `Mutation` and `Subscription` type in the same way: a graphql-java-annotations syntax, `@Component` annotation on top of the class, and implementing the `MutationRoot` or `SubscriptionRoot` interfaces accordingly.

### Directives

For directives to be added to your schema, you only need to put the `@GraphQLDirectiveDefinition` annotation (it is required by graphql-java-annotations) and your directives will be injected to the schema. No `@Component` is required.

You also have to assign the configuration `directives.package` in your properties file, with the value being the package where your directives at.

For example:

```java
@GraphQLName("upper")
@GraphQLDescription("upper")
@GraphQLDirectiveDefinition(wiring= UpperDirectiveWiring.class)
@DirectiveLocations({Introspection.DirectiveLocation.FIELD_DEFINITION, Introspection.DirectiveLocation.ARGUMENT_DEFINITION})
public class UpperDirectiveDefinition {
    private boolean isActive = true;
}
```

### Additional Types

If you have an additional graphql types that cannot be refered directly from the root types (for example, if you have a field in Query with return type A but A is an interface that has the B implementation. B is not directly declared in the Query class so it won't be added automatically),
you need to implement the `AdditionalGraphQLType` interface and add `@Component` annotation on top of the class.

### Configurations

Add a properties file (using the graphql-spring-boot settings), for example `application.yml`:

```yaml
spring:
  application:
    name: graphql-todo-app
  servlet:
    multipart:
      enabled: true
      location: /tmp
server:
  port: 8080
management:
  endpoints:
    web:
      exposure:
        include: health,info,metrics
graphql:
  servlet:
    tracing-enabled: false
    actuator-metrics: false
    contextSetting: PER_REQUEST_WITH_INSTRUMENTATION
altair:
  enabled: true
  cdn:
    enabled: false
graphiql:
  enabled: true
  cdn:
    enabled: false
voyager:
  enabled: false
  cdn:
    enabled: false
graphql.playground:
  enabled: false
  cdn:
    enabled: false    
directives.package: graphqla.directives
```

And you can go run your Application class.
That's it.

graphql-spring-annotations

graphql-spring-annotations 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

graphql-spring-annotations

graphql-spring-annotations 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README