Skip to content

Commit dee83f0

Browse files
committed
fixes #13 change project name to light-graphql-4j
1 parent 131e800 commit dee83f0

File tree

18 files changed

+103
-214
lines changed

18 files changed

+103
-214
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
99

1010
### Changed
1111

12+
## 1.3.0 - 2017-05-05
13+
### Added
14+
15+
### Changed
16+
- Fixes #13 change project name to light-graphql-4j from light-java-graphql
17+
- Upgrade to light-4j 1.3.0
18+
1219
## 1.2.8 - 2017-05-02
1320
### Added
1421

CONTRIBUTING.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# How to contribute
22

3-
Third-party patches are essential for keeping Light Java great. We simply can't
4-
access the huge number of platforms and myriad configurations for running
5-
Light Java. We want to keep it as easy as possible to contribute changes that
6-
get things working in your environment. There are a few guidelines that we
7-
need contributors to follow so that we can have a chance of keeping on
8-
top of things.
3+
Third-party patches are essential for keeping light-graphql-4j great. We simply
4+
can't access the huge number of platforms and myriad configurations for running
5+
light-graphql-4j. We want to keep it as easy as possible to contribute changes
6+
that get things working in your environment. There are a few guidelines that we
7+
need contributors to follow so that we can have a chance of keeping on top of
8+
things.
99

1010
## Core vs Modules
1111

1212
New functionality is typically directed toward middleware components to provide
13-
a slimmer Framework Core, reducing its surface area, and to allow greater freedom for
14-
middleware developers and maintainers.
13+
a slimmer framework Core, reducing its surface area, and to allow greater freedom
14+
for middleware developers and maintainers.
1515

1616
If you are unsure of whether your contribution should be implemented as a
17-
middleware component or part of Framework Core, you may visit
18-
[Gitter Chat](https://gitter.im/networknt/light-java) for advice.
17+
middleware component or part of framework core, you may visit
18+
[Gitter Chat](https://gitter.im/networknt/light-graphql-4j) for advice.
1919

2020
## Getting Started
2121

@@ -28,12 +28,11 @@ middleware component or part of Framework Core, you may visit
2828
## Making Changes
2929

3030
* Create a topic branch from where you want to base your work.
31-
* This is usually the master branch.
32-
* Only target release branches if you are certain your fix must be on that
31+
* This is usually the develop branch.
32+
* Only target master branch if you are certain your fix must be on that
3333
branch.
34-
* To quickly create a topic branch based on master; `git checkout -b
35-
fix/master/my_contribution master`. Please avoid working directly on the
36-
`master` branch.
34+
* To quickly create a topic branch based on develop; `git checkout -b
35+
fix32 develop`. Please avoid working directly on the `master` branch.
3736
* Make commits of logical units.
3837
* Check for unnecessary whitespace with `git diff --check` before committing.
3938
* Make sure your commit messages are in the proper format.
@@ -63,5 +62,7 @@ Adding new examples or enhance examples won't need to create a new issue.
6362

6463
* [General GitHub documentation](https://help.github.com/)
6564
* [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
66-
* [Light Java Document](https://networknt.github.io/light-java/)
67-
* [Light Java Gitter](https://gitter.im/networknt/light-java)
65+
* [Light 4J Document](https://networknt.github.io/light-4j/)
66+
* [Light 4J Gitter](https://gitter.im/networknt/light-4j)
67+
* [Light GraphQL 4J Document](https://networknt.github.io/light-graphql-4j/)
68+
* [Light GraphQL 4J Gitter](https://gitter.im/networknt/light-graphql-4j)

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
GraphQL implementation based on light-java
1+
GraphQL framework based on light-4j
22

3-
[Developer Chat](https://gitter.im/networknt/light-java-graphql) |
4-
[Documentation](https://networknt.github.io/light-java-graphql/introduction/) |
3+
[Developer Chat](https://gitter.im/networknt/light-graphql-4j) |
4+
[Documentation](https://networknt.github.io/light-graphql-4j/introduction/) |
55
[Contribution Guide](CONTRIBUTING.md) |
66

7-
[![Build Status](https://travis-ci.org/networknt/light-java-graphql.svg?branch=master)](https://travis-ci.org/networknt/light-java-graphql)
7+
[![Build Status](https://travis-ci.org/networknt/light-graphql-4j.svg?branch=master)](https://travis-ci.org/networknt/light-graphql-4j)
88

99
## Components
1010

@@ -29,11 +29,9 @@ graphql query parameter and body.
2929

3030
## Examples
3131

32-
### [Hello](https://github.com/networknt/light-java-example/tree/master/graphql/hello)
33-
34-
### [Mutation](https://github.com/networknt/light-java-example/tree/master/graphql/mutation)
35-
36-
### [RelayTodo](https://github.com/networknt/light-java-example/tree/master/graphql/relaytodo)
32+
### [Hello](https://github.com/networknt/light-example-4j/tree/master/graphql/hello)
3733

34+
### [Mutation](https://github.com/networknt/light-example-4j/tree/master/graphql/mutation)
3835

36+
### [RelayTodo](https://github.com/networknt/light-example-4j/tree/master/graphql/relaytodo)
3937

docs/config.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
baseurl = "https://networknt.github.io/light-java-graphql/"
1+
baseurl = "https://networknt.github.io/light-graphql-4j/"
22
languageCode = "en-us"
3-
title = "Light Java GraphQL - A GraphQL framework built on top of Light-Java"
3+
title = "Light GraphQL 4J - A GraphQL framework built on top of light-4j"
44
theme = "hugo-material-docs"
55
metadataformat = "yaml"
66
canonifyurls = true
@@ -10,14 +10,14 @@ googleAnalytics = ""
1010
[params]
1111
# General information
1212
author = "Steve Hu"
13-
description = "Light Java GraphQL Docs"
13+
description = "Light GraphQL 4J Docs"
1414
copyright = "Released under the MIT license"
1515

1616
# Repository
1717
provider = "GitHub"
18-
repo_url = "https://github.com/networknt/light-java-graphql"
18+
repo_url = "https://github.com/networknt/light-graphql-4j"
1919

20-
version = "1.2.6"
20+
version = "1.3.0"
2121
logo = "images/logo.png"
2222
favicon = ""
2323

@@ -72,7 +72,7 @@ googleAnalytics = ""
7272

7373
[[menu.main]]
7474
name = "Issues & Help"
75-
url = "https://github.com/networknt/light-java-graphql/issues"
75+
url = "https://github.com/networknt/light-graphql-4j/issues"
7676
weight = 60
7777

7878
[[menu.main]]

docs/content/components/graphql-router.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ The router is a HandlerProvider and it needs to be put into file
1010
/src/main/resources/META-INF/services/com.networknt.server.HandlerProvider
1111
in your GraphQL API/service.
1212

13-
The [link](https://github.com/networknt/light-java-example/blob/master/graphql/mutation/src/main/resources/META-INF/services/com.networknt.server.HandlerProvider)
13+
The [link](https://github.com/networknt/light-example-4j/blob/master/graphql/mutation/src/main/resources/META-INF/services/com.networknt.server.HandlerProvider)
1414
is an example.
1515

1616
The user developed schema needs to be hooked to the GraphqlPostHandler in this module through
1717
SchemaProvider interface. The SPI config file should be located at
1818
/src/main/resources/META-INF/services/com.networknt.graphql.router.SchemaProvider
1919

20-
The [link](https://github.com/networknt/light-java-example/blob/master/graphql/mutation/src/main/resources/META-INF/services/com.networknt.graphql.router.SchemaProvider)
20+
The [link](https://github.com/networknt/light-example-4j/blob/master/graphql/mutation/src/main/resources/META-INF/services/com.networknt.graphql.router.SchemaProvider)
2121
is an example.
2222

docs/content/components/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,17 @@ title: Light Java GraphQL Components
55

66
## Common Components
77

8-
* [graphql-common](https://networknt.github.io/light-java-graphql/components/graphql-common/)
8+
* [graphql-common](https://networknt.github.io/light-graphql-4j/components/graphql-common/)
99
contains common utilities and static variables that are shared by other components.
1010

11-
* [graphql-router](https://networknt.github.io/light-java-graphql/components/graphql-router/)
11+
* [graphql-router](https://networknt.github.io/light-graphql-4j/components/graphql-router/)
1212
is responsible for handling GraphQL and GraphiQL requests and hooks schema provider.
1313

1414
## Middleware Handlers
1515

16-
* [graphql-security](https://networknt.github.io/light-java-graphql/components/graphql-security/)
16+
* [graphql-security](https://networknt.github.io/light-graphql-4j/components/graphql-security/)
1717
verifies JWT token in request header and verifies scopes if it is enabled.
1818

19-
* [graphql-validator](https://networknt.github.io/light-java-graphql/components/graphql-validator/)
19+
* [graphql-validator](https://networknt.github.io/light-graphql-4j/components/graphql-validator/)
2020
validates the path and methods of the request. Other schema validation will be handled by the
2121
GraphQL componnent.
22-

docs/content/getting-started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ To get started, an easy way is to copy one of the examples and replace the schem
77

88
If you compare between the examples, the only difference is schema classes.
99

10-
Here is the [link](https://github.com/networknt/light-java-example/tree/master/graphql) to examples.
10+
Here is the [link](https://github.com/networknt/light-example-4j/tree/master/graphql) to examples.

docs/content/introduction/index.md

Lines changed: 5 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -1,137 +1,21 @@
11
---
22
date: 2017-03-26T21:03:44-04:00
3-
title: Light Java GraphQL
3+
title: Light GraphQL 4J
44
---
55

6-
[Light Java](https://github.com/networknt/light-java) is a framework built on top
7-
of Undertow core HTTP server that addresses all the cross-cutting concerns for
8-
microservices in the request and response chain. [Light Java REST](https://github.com/networknt/light-java-rest)
9-
is built on top of Light Java and focuses on RESTful services with OpenAPI
10-
specification loaded at runtime to drive security and validation. [Light Java GraphQL](https://github.com/networknt/light-java-graphql)
11-
is based on Light Java and is our solution for [GraphQL](http://graphql.org/) services.
12-
13-
With Light Java GraphQL, developers can only focus on Schema development and the rest
14-
of the functionalities are provided by the framework. These includes:
15-
16-
### Common Components
17-
18-
* [server](https://networknt.github.io/light-java/other/server/) is
19-
a framework on top of Undertow http core that support plugins to perform
20-
different middleware handlers. It is light-weight, fast and supports HTTP/2.
21-
22-
* [config](https://networknt.github.io/light-java/other/config/) is a module that
23-
supports externalized yml/yaml/json configuration for standalone applications and
24-
docker containers managed by Kubernetes. Config files are managed by
25-
[light-config-server](https://github.com/networknt/light-config-server) and mapped
26-
to Kubernetes ConfigMap and Secrets.
27-
28-
* [utility](https://networknt.github.io/light-java/other/utility/) contains utility
29-
classes and static variables that are shared between modules.
30-
31-
* [client](https://networknt.github.io/light-java/other/client/) is a wrapper of
32-
apache HttpClient and HttpAsyncClient. It supports automatically cache and
33-
renew client credentials JWT tokens and manages connection pooling. It is also
34-
responsible for passing correlationId and traceabilityId to the next service.
35-
36-
* [info](https://networknt.github.io/light-java/other/info/) is a handler that
37-
injects an endpoint /server/info to all server instances so that light-portal
38-
can pull the info to certify all the enabled components and their configuration
39-
at runtime. It also helps while debugging issues on the server.
40-
41-
* [mask](https://networknt.github.io/light-java/other/mask/) is used to mask
42-
sensitive info before logging.
43-
44-
* [status](https://networknt.github.io/light-java/other/status/) is used to model
45-
error http response and assist production monitoring with unique error code.
46-
47-
* [security](https://networknt.github.io/light-java/other/status/) is used by
48-
swagger-security and graphql-security currently but these utilities and helpers can
49-
be used by other security handlers for Role-Based or Attribute-Based Authorization.
50-
51-
* [balance](https://networknt.github.io/light-java/other/balance/) is a load balance
52-
module that is used by cluster module with service discovery module. It will be called
53-
from client module and be part of client side discovery.
54-
55-
* [cluster](https://networknt.github.io/light-java/other/cluster/) ia a module caches
56-
discovered services and calling load balance module for load balancing. Part of client
57-
side discovery.
58-
59-
* [consul](https://networknt.github.io/light-java/other/consul/) is a module manages
60-
communication with Consul server for registry and discovery.
61-
62-
* [handler](https://networknt.github.io/light-java/other/handler/) is a module defines
63-
middleware handler interface for all middleware components.
64-
65-
* [Health](https://networknt.github.io/light-java/other/health/) is a health check module
66-
that can be called by API portal to determine if the service is healthy. It supports
67-
cascade health check for databases or message queues.
68-
69-
* [registry](https://networknt.github.io/light-java/other/registry/) ia an interface
70-
definition and generic direct registry implementation for service registry and discovery.
71-
72-
* [service](https://networknt.github.io/light-java/other/service/) is a light weight
73-
dependency injection framework for testing and startup hooks.
74-
75-
* [switcher](https://networknt.github.io/light-java/other/switcher/) is a switcher that
76-
turns things on and off based on certain conditions.
77-
78-
* [zookeeper](https://networknt.github.io/light-java/other/zookeeper/) is a module manages
79-
communication with ZooKeeper server for service registry and discovery.
80-
81-
### Middleware Handlers
82-
83-
* [audit](https://networknt.github.io/light-java/middleware/audit/) logs most important info
84-
about request and response into audit.log in JSON format with config file that controls which
85-
fieds to be logged.
86-
87-
* [body](https://networknt.github.io/light-java/middleware/body/) is a body parser middleware
88-
that is responsible for parsing the content of the request based on Content-Type in the
89-
request header.
90-
91-
* [exception](https://networknt.github.io/light-java/middleware/exception/) is a generic
92-
exception handler that handles runtime exception, ApiException and other checked exception
93-
if they are not handled properly in the handler chain.
94-
95-
* [metrics](https://networknt.github.io/light-java/middleware/metrics/) is a module that collects
96-
API runtime info based on clientId and API name. The metrics info is sent to InfluxDB and
97-
accessible from Grafana Dashboard.
98-
99-
* [sanitizer](https://networknt.github.io/light-java/middleware/sanitizer/) is a
100-
middleware that address cross site scripting concerns. It encodes header and body based on
101-
configuration.
102-
103-
* [correlation](https://networknt.github.io/light-java/middleware/correlation/) generates
104-
a UUID in the first API/service and pass it to all other APIs/services in the call tree for
105-
tracking purpose.
106-
107-
* [traceability](https://networknt.github.io/light-java/middleware/traceability/) is an
108-
id passed in from client and will be unique with an application context. The id will be passed
109-
into the backend and return to the consumer for transaction tracing.
110-
111-
* [cors](https://networknt.github.io/light-java/middleware/cors/) is a module handles
112-
Cross-Origin Resource Sharing (CORS) pre-flight OPTIONS to support single page applications
113-
from another domain to access APIs/services.
114-
115-
* [dump](https://networknt.github.io/light-java/middleware/dump/) is a full request/response
116-
log handler to dump everything regarding to request and response into log file for developers.
117-
118-
* [limit](https://networknt.github.io/light-java/middleware/limit/) is a rate limiting handler
119-
to limit number of concurrent requests on the server. Once the limit is reached, subsequent
120-
requests will be queued for later execution. The size of the queue is configurable.
121-
1226
### GraphQL Specific Components
1237

124-
* [graphql-common](https://networknt.github.io/light-java-graphql/components/graphql-common/)
8+
* [graphql-common](https://networknt.github.io/light-graphql-4j/components/graphql-common/)
1259
contains common utilities and static variables that are shared by other components.
12610

127-
* [graphql-router](https://networknt.github.io/light-java-graphql/components/graphql-router/)
11+
* [graphql-router](https://networknt.github.io/light-graphql-4j/components/graphql-router/)
12812
is responsible for handling GraphQL and GraphiQL requests and hooks schema provider.
12913

13014
### GraphQL Specific Middleware Handlers
13115

132-
* [graphql-security](https://networknt.github.io/light-java-graphql/components/graphql-security/)
16+
* [graphql-security](https://networknt.github.io/light-graphql-4j/components/graphql-security/)
13317
verifies JWT token in request header and verifies scopes if it is enabled.
13418

135-
* [graphql-validator](https://networknt.github.io/light-java-graphql/components/graphql-validator/)
19+
* [graphql-validator](https://networknt.github.io/light-graphql-4j/components/graphql-validator/)
13620
validates the path and methods of the request. Other schema validation will be handled by the
13721
GraphQL component.

docs/content/roadmap/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Roadmap
55

66
The current framework is working and there are several examples can be found at
77

8-
https://github.com/networknt/light-java-example/tree/master/graphql
8+
https://github.com/networknt/light-example-4j/tree/master/graphql
99

1010
There are several things in mind to improved it.
1111

docs/content/tutorials/hello.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ date: 2017-03-27T17:05:10-04:00
33
title: Hello World Tutorial
44
---
55

6-
This is the first example application and the [README.md](https://github.com/networknt/light-java-example/tree/master/graphql/hello)
6+
This is the first example application and the [README.md](https://github.com/networknt/light-example-4j/tree/master/graphql/hello)
77
shows how to use it.
88

9-
Unlike [light-java-rest](https://github.com/networknt/light-java-rest) has a [swagger-codegen](https://github.com/networknt/swagger-codegen)
9+
Unlike [light-rest-4j](https://github.com/networknt/light-rest-4j) has a [swagger-codegen](https://github.com/networknt/swagger-codegen)
1010
to generate the project, we have to construct the project based on the [petstore](https://github.com/networknt/light-java-example/tree/master/petstore)
1111
example and modify some files for GraphQL.
1212

0 commit comments

Comments
 (0)