mercury

module
v0.0.0-...-a2bedd5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 28, 2023 License: Apache-2.0

README

The Lura Project framework

Go Report Card GoDoc CII Best Practices Docker Pulls Slack Widget FOSSA Status

An open framework to assemble ultra performance API Gateways with middlewares; formerly known as KrakenD framework, and core service of the KrakenD API Gateway.

Motivation

Consumers of REST API content (specially in microservices) often query backend services that weren't coded for the UI implementation. This is of course a good practice, but the UI consumers need to do implementations that suffer a lot of complexity and burden with the sizes of their microservices responses.

Lura is an API Gateway builder and proxy generator that sits between the client and all the source servers, adding a new layer that removes all the complexity to the clients, providing them only the information that the UI needs. Lura acts as an aggregator of many sources into single endpoints and allows you to group, wrap, transform and shrink responses. Additionally it supports a myriad of middlewares and plugins that allow you to extend the functionality, such as adding Oauth authorization or security layers.

Lura not only supports HTTP(S), but because it is a set of generic libraries you can build all type of API Gateways and proxies, including for instance, an RPC gateway.

Practical Example

A mobile developer needs to construct a single front page that requires data from 4 different calls to their backend services, e.g:

1) api.store.server/products
2) api.store.server/marketing-promos
3) api.users.server/users/{id_user}
4) api.users.server/shopping-cart/{id_user}

The screen is very simple, and the mobile client only needs to retrieve data from 4 different sources, wait for the round trip and then hand pick only a few fields from the response.

What if the mobile could call a single endpoint?

1) lura.server/frontpage/{id_user}

That's something Lura can do for you. And this is how it would look like:

Gateway

Lura would merge all the data and return only the fields you need (the difference in size in the graph).

Visit the Lura Project website for more information.

What's in this repository?

The source code for the Lura project framework. It is designed to work with your own middleware and extend the functionality by using small, independent, reusable components following the Unix philosophy.

Use this repository if you want to build from source your API Gateway or if you want to reuse the components in another application.

If you need a fully functional API Gateway you can download the KrakenD binary for your architecture or build it yourself.

Library Usage

The Lura project is presented as a Go library that you can include in your own Go application to build a powerful proxy or API gateway. For a complete example, check the KrakenD CE repository.

Of course, you will need Go installed in your system to compile the code.

A ready to use example:

    package main

    import (
        "flag"
        "log"
        "os"

        "github.com/luraproject/lura/config"
        "github.com/luraproject/lura/logging"
        "github.com/luraproject/lura/proxy"
        "github.com/luraproject/lura/router/gin"
    )

    func main() {
        port := flag.Int("p", 0, "Port of the service")
        logLevel := flag.String("l", "ERROR", "Logging level")
        debug := flag.Bool("d", false, "Enable the debug")
        configFile := flag.String("c", "/etc/lura/configuration.json", "Path to the configuration filename")
        flag.Parse()

        parser := config.NewParser()
        serviceConfig, err := parser.Parse(*configFile)
        if err != nil {
            log.Fatal("ERROR:", err.Error())
        }
        serviceConfig.Debug = serviceConfig.Debug || *debug
        if *port != 0 {
            serviceConfig.Port = *port
        }

        logger, _ := logging.NewLogger(*logLevel, os.Stdout, "[LURA]")

        routerFactory := gin.DefaultFactory(proxy.DefaultFactory(logger), logger)

        routerFactory.New().Run(serviceConfig)
    }

Visit the framework overview for more details about the components of the Lura project.

Configuration file

Lura config file

Benchmarks

Check out the benchmark results of several Lura components

Contributing

We are always happy to receive contributions. If you have questions, suggestions, bugs please open an issue. If you want to submit the code, create the issue and send us a pull request for review.

Read CONTRIBUTING.md for more information.

Want more?

Enjoy Lura!

License

FOSSA Status

Directories

Path Synopsis
Package backoff contains some basic implementations and a selector by strategy name
Package backoff contains some basic implementations and a selector by strategy name
Package config defines the config structs and some config parser interfaces and implementations
Package config defines the config structs and some config parser interfaces and implementations
Package core contains some basic constants and variables
Package core contains some basic constants and variables
Package encoding provides basic decoding implementations.
Package encoding provides basic decoding implementations.
Package logging provides a simple logger interface and implementations
Package logging provides a simple logger interface and implementations
Package plugin provides tools for loading and registering plugins
Package plugin provides tools for loading and registering plugins
Package proxy provides proxy and proxy middleware interfaces and implementations.
Package proxy provides proxy and proxy middleware interfaces and implementations.
plugin
Package plugin provides tools for loading and registering proxy plugins
Package plugin provides tools for loading and registering proxy plugins
Package register offers tools for creating and managing registers.
Package register offers tools for creating and managing registers.
Package router defines some interfaces and common helpers for router adapters
Package router defines some interfaces and common helpers for router adapters
chi
Package chi provides some basic implementations for building routers based on go-chi/chi
Package chi provides some basic implementations for building routers based on go-chi/chi
gin
Package gin provides some basic implementations for building routers based on gin-gonic/gin
Package gin provides some basic implementations for building routers based on gin-gonic/gin
gorilla
Package gorilla provides some basic implementations for building routers based on gorilla/mux
Package gorilla provides some basic implementations for building routers based on gorilla/mux
httptreemux
Package httptreemux provides some basic implementations for building routers based on dimfeld/httptreemux
Package httptreemux provides some basic implementations for building routers based on dimfeld/httptreemux
mux
Package mux provides some basic implementations for building routers based on net/http mux
Package mux provides some basic implementations for building routers based on net/http mux
negroni
Package negroni provides some basic implementations for building routers based on urfave/negroni
Package negroni provides some basic implementations for building routers based on urfave/negroni
sd
Package sd defines some interfaces and implementations for service discovery
Package sd defines some interfaces and implementations for service discovery
dnssrv
Package dnssrv defines some implementations for a dns based service discovery
Package dnssrv defines some implementations for a dns based service discovery
Package test contains the integration tests for the KrakenD framework
Package test contains the integration tests for the KrakenD framework
transport
http/client
Package client provides some http helpers to create http clients and executors
Package client provides some http helpers to create http clients and executors
http/client/graphql
Package graphql offers a param extractor and basic types for building GraphQL requests
Package graphql offers a param extractor and basic types for building GraphQL requests
http/client/plugin
Package plugin provides plugin register interfaces for building http client plugins.
Package plugin provides plugin register interfaces for building http client plugins.
http/server
Package server provides tools to create http servers and handlers wrapping the lura router
Package server provides tools to create http servers and handlers wrapping the lura router
http/server/plugin
Package plugin provides plugin register interfaces for building http handler plugins.
Package plugin provides plugin register interfaces for building http handler plugins.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL