Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport federation to 1.9.x #1585

Merged
merged 17 commits into from
Oct 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions docs/federation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Federation

To enable support for [GraphQL Federation](https://www.apollographql.com/docs/federation), simply set the `smallrye.graphql.federation.enabled` config key to `true`.

You can add the Federation directives by using the equivalent Java annotation, e.g. to extend a `Product` entity with a `price` field, you can write a class:

```java
package org.example.price;

import org.eclipse.microprofile.graphql.Id;

import io.smallrye.graphql.api.federation.Extends;
import io.smallrye.graphql.api.federation.Key;

@Extends @Key(fields = "id")
public class Product {
@Id
private String id;

@Description("The price in cent")
private Integer price;

// getters and setters omitted
}
```

And a normal query method that takes the `key` fields as a parameter and returns the requested type:

```java
package org.example.price;

import org.eclipse.microprofile.graphql.GraphQLApi;
import org.eclipse.microprofile.graphql.Id;
import org.eclipse.microprofile.graphql.Query;

@GraphQLApi
public class Prices {
@Query
public Product product(@Id String id) {
return ...;
}
}
```

The GraphQL Schema then contains:

```graphql
type Product @extends @key(fields : ["id"]) {
id: ID
price: Int
}

union _Entity = Product

type Query {
_entities(representations: [_Any!]!): [_Entity]!
_service: _Service!
product(id: ID): Product
}
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ nav:
- Server side features:
- Customizing JSON deserializers: 'custom-json-deserializers.md'
- Directives: 'directives.md'
- Federation: 'federation.md'
- Custom error extensions: 'custom-error-extensions.md'
- Typesafe client:
- Basic usage: 'typesafe-client-usage.md'
Expand Down
6 changes: 6 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
<version.jakarta-validation>2.0.2</version.jakarta-validation>
<version.jakarta-annotation>1.3.5</version.jakarta-annotation>
<version.graphql-java>19.2</version.graphql-java>
<version.graphql-java-federation>2.0.8</version.graphql-java-federation>
<verison.io.micrometer>1.9.3</verison.io.micrometer>
<version.vertx>4.3.3</version.vertx>

Expand Down Expand Up @@ -231,6 +232,11 @@
<artifactId>graphql-java</artifactId>
<version>${version.graphql-java}</version>
</dependency>
<dependency>
<groupId>com.apollographql.federation</groupId>
<artifactId>federation-graphql-java-support</artifactId>
<version>${version.graphql-java-federation}</version>
</dependency>

<dependency>
<groupId>io.vertx</groupId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.smallrye.graphql.federation.api;
package io.smallrye.graphql.api.federation;

import static io.smallrye.graphql.api.DirectiveLocation.INTERFACE;
import static io.smallrye.graphql.api.DirectiveLocation.OBJECT;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.smallrye.graphql.federation.api;
package io.smallrye.graphql.api.federation;

import static io.smallrye.graphql.api.DirectiveLocation.FIELD_DEFINITION;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.smallrye.graphql.federation.api;
package io.smallrye.graphql.api.federation;

import static io.smallrye.graphql.api.DirectiveLocation.INTERFACE;
import static io.smallrye.graphql.api.DirectiveLocation.OBJECT;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.smallrye.graphql.federation.api;
package io.smallrye.graphql.api.federation;

import static io.smallrye.graphql.api.DirectiveLocation.FIELD_DEFINITION;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.smallrye.graphql.federation.api;
package io.smallrye.graphql.api.federation;

import static io.smallrye.graphql.api.DirectiveLocation.FIELD_DEFINITION;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
Expand Down
46 changes: 0 additions & 46 deletions server/federation/README.adoc

This file was deleted.

26 changes: 0 additions & 26 deletions server/federation/api/pom.xml

This file was deleted.

This file was deleted.

37 changes: 0 additions & 37 deletions server/federation/pom.xml

This file was deleted.

42 changes: 0 additions & 42 deletions server/federation/runtime/pom.xml

This file was deleted.

Loading