Light Proxy Tutorial

Light-proxy is a critical service component that can glue all other alien APIs into the Light ecosystem without re-writing. Once putting light-proxy in front of legacy APIs, these API can enjoy all the cross-cutting concerns provided by the light-platform, such as security, metrics, auditing, traceability, validation, service registry/discovery, etc. From the consumer point of view, your backend API looks just like an API built on top of light-4j frameworks.

OpenAPI 3.0 Backend

Docker

  • Proxy Docker will show you how to use dockerized proxy with externalized config files

Confluent Schema Registry

  • Schema Registry shows how to give read-only access to Internet applications and give write access to internal applications

Enable Metrics on Proxy

  • Proxy Metrics shows how to enable metrics on the proxy server with InfluxDB as the database.

Proxy Metrics

The following tutorial will enable the metrics handler on light-proxy. Backend API Let’s start the backend API first by following the OpenAPI Backend. We only need to start the first instance with port 8081 for this tutorial as load balancing is not a concern for this tutorial. InfluxDB Before starting the proxy server, we need to have a local InfluxDB instance. Let’s start the InfluxDB with Docker by following the Petstore Metrics tutorial. Read More »

Schema Registry with Proxy

When building the taiji-blockchain, we are using Avro for binary encoding and decoding for service to service communication. To make sure that the size of the binary data is smallest, we need a centralized server to save all the schema so that only a schema ID will be serialized into the binary data. Both clients and services will go to the centralized schema registry to get the Avro schema to encode and decode the data. Read More »

Docker

In this tutorial, we are going to walk through the dockerized light-proxy in light-docker. There are two docker-compose files and separate config files for Swagger 2.0 and OpenAPI 3.0 specification. We are going to use OpenAPI 3.0 compose file, and Swagger 2.0 is very similar to the OpenAPI 3.0 one with only config file difference. Start backend services Before we start the proxy compose, we need to start three instances of OpenAPI proxy-backend services. Read More »

OpenAPI Proxy

In this second part of the tutorial, we are going to use OpenAPI 3.0 RESTful API as an example to show how to deploy the light-proxy and enable all sorts of middleware handlers through configurations. We also explore standalone deployment and Docker deployment. With the specification handler, security handler, and validation handler change, you can easily update the configuration to make the same instance of light-proxy server work with OpenAPI 3. Read More »

OpenAPI Backend

This tutorial will create a backend service and start three instances to demo the light-proxy load balance between them. The backend service will have two endpoints: one get and one post to demo different proxy functionality scenarios. This server is built on top of light-rest-4j with OpenAPI 3.0 specification. Backend service specification and light-codegen config.json You can find the OpenAPI 3.0 specification and config.json in model-config Regarding how to create OpenAPI 3. Read More »