Superpowers

Table of Contents

1. About
2. Architecture
3. API Structure
4. Endpoints
5. Sample Request
6. Repo Automation

About

A Proof-of-concept for a composable API that is built as modular set of serverless functions.

Architecture

The project has three components:

1. Lambda functions

   The foundation of Superpowers is a set of Lambda functions.

   The main sub dir is functions.

2. Terraform configuration

   The corresponding infrastructure is managed using Terraform.

   The main sub dir is terraform.

3. Landing page

   The frontend serving as the main entry point for potential/new customers is based on Nuxt using TailwindCSS.

   The main sub dir is landing.

4. Documentation

   The documentation is covers

   • the general API structure
   • descriptions of individual services
   • glossary

   It is based on Nuxt Content > Docs Theme using TailwindCSS allowing it to be written as markdown files. It is developed inside the separated and public repo named sp_docs.

Endpoints

Endpoint	Name	Auth	Description
/	Main	True	Returns the result of the functions
/help (inactive)	Help	False	Provides i) general information about how to use the main endpoint and ii) specific details.
/sample (inactive)	Sample	False	Returns sample data for each
/statistics (inactive)	Statistics	False	Returns statistics for each service.

Sample Request

{
    'data': [1,2,3,4],
    'services': [
        {
            'position':1,
            'name': 'get_sum',
        },
        {
            'position':2,
            'name': 'get_rounded',
        }
    ],
    'visualization': None
}

Repo Automation

This repo uses the following bots:

• Dependabot
• Pull: Keep your forks up-to-date via automated PRs
• Semantic Pull Requests: Ensure that every PR has just enough semantic information to be able to trigger a release when appropriate
• Todo: Automagically creates new issues based on comments and keywords in your code when you push it to GitHub