Brasil Paralelo OpenAPI 3.x

Brasil Paralelo OpenAPI 3.x
using
Clojure and Luminus Web Framework.

www.jpventura.com

Contributing Guidelines · Submit an Issue · Blog

   

Changelog

Require to setup a predefined changelog script using the project main language.

Contributing

Require setup a license and CLA action at GitHub.

Setup

Just run docker-compose locally:

    docker-compose build openapi
    docker-compose up

Usage

First authenticate one of the avaiable users to generate a JWT token:

http http://0.0.0.0:3000/api/authorize \
    [email protected] \
    password=Iru0Dahng3Eepiel

You may access the API through:

• HTTPie CLI
• Postman App
• Swagger 2.x local host

The response is a JWT token

{
  "token": "eyJhbGciOiJBMjU2S1ciLCJlbm...QGXQzlPV_C9eQXHFORRVMA"
}

containing the following encrypted information

{
  "header": {
    "alg": "A256KW",
    "enc": "A128GCM"
  },
  "payload": {
    "admin": false,                                  // Admin privileges
    "exp": 1648852056,                               // Expiration timestamp
    "iat": 1648848456,                               // Issued at timestamp
    "type": "patriot",                               // (basic, premium, patriot, patron)
    "sub": "26bd2f1f-98a5-4c65-9baf-347fa43f5194"    // User ID
  }
}

The token contain all information required to authentication and RBAC authorization. So users will obtain different outputs for the same endpoint:

http http://0.0.0.0:3000/api/media/ \
    Authorization:'Token eyJhbGciOiJBMjU2S1ciLCJlbm...QGXQzlPV_C9eQXHFORRVMA'

[{
      "id": "78e34217-8be2-46f0-b4b8-1f654fcdd591",
      "name": "CORINGA - Podcast Cultura Paralela #1",
      "released_at": "2020-03-29T20:02:34",
      "type": "podcast"
  },
  {
      "id": "abeff106-6b4e-4f02-9b8b-2f4844af2f49",
      "name": "Brasil - A Última Cruzada",
      "released_at": "2021-07-08T16:37:11",
      "type": "series"
  },
  {
    "id": "95f80b8c-fae2-479a-a7d4-3191178018de",
    "name": "Qual o limite do Respeito?",
    "released_at": "2020-03-29T20:02:34",
    "type": "debate"
  },
  {
    "id": "801486de-892d-4969-933d-37e12d62065d",
    "name": "INTERESTELAR - Podcast Cultura Paralela #2",
    "released_at": "2020-03-29T20:02:34",
    "type": "podcast"
  },
  {
    "id": "ef1195f8-dd0f-429c-a26e-66f07687dbbc",
    "name": "Congresso Brasil Paralelo - Rodrigo gurgel",
    "released_at": "2021-01-24T11:45:57",
    "type": "interview"
}]

A prepopulated database will be available with the following users:

name	email	password
Miles Bennett Dyson	[email protected]	aiH0Diuchik2Quoo
Sarah Connor	[email protected]	Iru0Dahng3Eepiel
John Connor	[email protected]	Eez3xahfaero9eih
Kyle Reese	[email protected]	Zahjo6joh4Gah8bu