Skip to content

Example Project contains samples of various Knot.x modules implementations and usages

License

Notifications You must be signed in to change notification settings

oskarjerzyk/knotx-example-project

 
 

Build Status

Knot.x Examples

Examples show how you can customize/extend Knot.x Stack in a real project. They use Gradle to build all custom modules and prepare a distribution containing custom configurations and modules.

Topics covered in our examples:

Distribution

Within this module, you will see what Stack is and how it can be customized. It also contains details on how to use Starter Kit template project to prepare a custom project distribution.

Although we recommend to start with Starter Kit that builds Docker image, using Docker is not mandatory.

Topic Description Used technologies Tutorial Source code
Stack Basic usage of fragmentsHandler with a simple graph that uses data from external API and combines them with a static HTML provided by fsRepoConnectionHandler. Stack Getting Started with Knot.x Stack ./distribution/knotx-stack
Docker This module covers the same topics as above. However, it uses Docker and embeds Knot.x Stack within a Docker image. Stack, Docker, Starter Kit template project Getting Started with Docker

API gateway

Knot.x is an integration framework that can be used as a simple API gateway. It can be also combined with Cloud solutions like Apigee Edge or Amazon API Gateway.

Topic Description Used technologies Tutorial Source code
Securing your API Simple usage of popular authentication technologies to secure your API. Docker, OAuth 2.0, OpenId Connect, JWT coming soon coming soon
Composing many APIs Presents how to combine data from many API (even dependent on each other) using Configurable Integrations. Fragments, WireMock, Docker Configurable API gateway ./api-gateway/composing-many-apis
GraphQL API Expose GraphQL API using Configurable Integrations. GraphQL, OpenAPI, Configurable Integrations Using GraphQL with Knot.x ./api-gateway/graphql-api

Template Processing

This module presents the aspects of template processing.

Topic Description Used technologies Tutorial Source code
Getting started Basic usage of fragmentsHandler with a simple graph that uses data from external API and combines them with a static HTML provided by fsRepoConnectionHandler Template Engine, Handlebars, Docker ./template-processing/handlebars

About

Example Project contains samples of various Knot.x modules implementations and usages

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 67.7%
  • Kotlin 26.9%
  • HTML 3.7%
  • Dockerfile 1.7%