Add main branch content for Session 3 #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also add client snippet with HTTP client.
| @@ -1 +1,387 @@ | |||
| # Backend implementation for Reviewed! | |||
|
|
|||
| A backend implementation for Reviewed!, a platform to review places. | |||
There was a problem hiding this comment.
Should we use backticks for Reviewed!.?
Just to imply that it is a name not a verb?
|
|
||
| Ballerina requires `distinct` objects (which is Ballerina's way of allowing nominal type-like behaviour) with interfaces and unions to differentiate between the possible return types. | ||
|
|
||
| - Now that done we're done with the core service implementations, next (level 7), let's introduce |
There was a problem hiding this comment.
Suggested change
| - Now that done we're done with the core service implementations, next (level 7), let's introduce | |
| - Now we're done with the core service implementations, next (level 7), let's introduce |
|
|
||
| - Maximum query depth - introduced in the service annotation, this restricts the depth of the query to avoid unnecessary processing for abnormal/malicious queries. | ||
|
|
||
| - Data loaders - Ballerina supports data loaders that allow avoiding the GraphQL N + 1 problem via batching and caching. In this version, we've only introduced the data loader for the city data retrieval calls, but we can introduce data loaders for database access too. Also see [GraphQL data loader](https://ballerina.io/learn/by-example/graphql-dataloader/). |
There was a problem hiding this comment.
Suggested change
| - Data loaders - Ballerina supports data loaders that allow avoiding the GraphQL N + 1 problem via batching and caching. In this version, we've only introduced the data loader for the city data retrieval calls, but we can introduce data loaders for database access too. Also see [GraphQL data loader](https://ballerina.io/learn/by-example/graphql-dataloader/). | |
| - Data loaders - Ballerina supports data loaders that allow avoiding the GraphQL N + 1 problem via batching and caching. In this version, we've only introduced the data loader for the city data retrieval calls, but we can introduce data loaders for database access, too. Also, see [GraphQL data loader](https://ballerina.io/learn/by-example/graphql-dataloader/). |
|
|
||
| - Data loaders - Ballerina supports data loaders that allow avoiding the GraphQL N + 1 problem via batching and caching. In this version, we've only introduced the data loader for the city data retrieval calls, but we can introduce data loaders for database access too. Also see [GraphQL data loader](https://ballerina.io/learn/by-example/graphql-dataloader/). | ||
|
|
||
| - Enabling SSL - set the relevant `secureSocket` configuration when creating the listener. Also see [GraphQL service security](https://ballerina.io/learn/by-example/#graphql-service-security). |
There was a problem hiding this comment.
Suggested change
| - Enabling SSL - set the relevant `secureSocket` configuration when creating the listener. Also see [GraphQL service security](https://ballerina.io/learn/by-example/#graphql-service-security). | |
| - Enabling SSL - set the relevant `secureSocket` configuration when creating the listener. Also, see [GraphQL service security](https://ballerina.io/learn/by-example/#graphql-service-security). |
|
|
||
| - Enabling SSL - set the relevant `secureSocket` configuration when creating the listener. Also see [GraphQL service security](https://ballerina.io/learn/by-example/#graphql-service-security). | ||
|
|
||
| - Field-level authorization - a simple (hard-coded) user ID-based authorization has been introduced to the `addPlace` mutation. The user ID from a request header is set to [the GraphQL context](https://ballerina.io/learn/by-example/graphql-context/) which is then accessed at field-level via a [field interceptor](https://ballerina.io/learn/by-example/graphql-field-interceptors/) to check if the user is authorized to add a place. |
There was a problem hiding this comment.
Suggested change
| - Field-level authorization - a simple (hard-coded) user ID-based authorization has been introduced to the `addPlace` mutation. The user ID from a request header is set to [the GraphQL context](https://ballerina.io/learn/by-example/graphql-context/) which is then accessed at field-level via a [field interceptor](https://ballerina.io/learn/by-example/graphql-field-interceptors/) to check if the user is authorized to add a place. | |
| - Field-level authorization - a simple (hard-coded) user ID-based authorization has been introduced to the `addPlace` mutation. The user ID from a request header is set to [the GraphQL context](https://ballerina.io/learn/by-example/graphql-context/), which is then accessed at field-level via a [field interceptor](https://ballerina.io/learn/by-example/graphql-field-interceptors/) to check if the user is authorized to add a place. |
|
|
||
| This will generate the schema at the specified [output path](./reviewed/schema/schema_reviewed.graphql). | ||
|
|
||
| - Note: if you want to enable GraphiQL and/or introspection, add the following also in the config file. |
There was a problem hiding this comment.
Suggested change
| - Note: if you want to enable GraphiQL and/or introspection, add the following also in the config file. | |
| - Note: If you want to enable GraphiQL and/or introspection, add the following also to the config file. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
$title.