Giter Club home page Giter Club logo

simple-bff's Introduction

A Very Simple BFF

Getting Started

Create a Resource File

The resources should be registered in the file resources/resources.json in the following format:

{
    "swapi-people": {
        "url":"https://swapi.dev/api/people/:personId/",
        "method":"GET"
    }
}

Create a Query File

The queries should be registered in the file queries/queries.json in the following format:

{
    "swapi-people": {
        "resource": "swapi-people", // configured resource
        "queryParams": [ // query params to add to request
            {
                "name": "format",
                "type": "constant",
                "value": "json"
            },
            {
                "name": "resourceQueryParamKey",
                "type": "querystring", // query param forwarded from request
                "value": "receivedQueryParam"
            }
        ],
        "pathParams": [ // path params to add to request
            {
                "name": "personId",
                "type": "querystring", // path param from query string
                "value": "otherReceivedQueryParam"
            }
        ],
        "headers": [ // headers to add to request
            {
                "name": "Authorization",
                "type": "constant",
                "value": "Bearer 1234"
            }
        ],
        "returns": ["name"] // fields to return from response
    }
}

Params can be of type constant, querystring, or header.

Start the Server

go run cmd/main.go

Make a Request

curl -X GET "http://localhost:8080/swapi-people?receivedQueryParam=aValue&otherReceivedQueryParam=1"

simple-bff's People

Contributors

thslopes avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.