consolebff

README

console BFF

Console Backend For Frontend

Specify the API

• write / update the API spec in openapi v3 format consolebff_openapi.yaml
• first time:
  • write makefile
  • go mod init gitlab.com/realtime-asset-monitor/consolebff

generate api boiler plate code

• First time:
  • mkdir consolebff
    • cd consolebff
      • mkdir models
      • specify the model generation config consolebff/models.cfg.yaml
      • specify the server generation config consolebff/server.cfg.yaml
• Manual:
  • generate models
    • oapi-codegen -config models.cfg.yaml ../consolebff_openapi.yaml
  • generate server side for echo framework
    • oapi-codegen -config server.cfg.yaml ../consolebff_openapi.yaml
• Automated:
  • First time
    • consolebff/func_new_handler.go with comments to trigger the code generation
  • make gogenerate makefile with a gogenerate target

Implement the api logic code

• For API operationId v1ListAssetNames
  • consolebff/method_v1_list_assetnames.go

Serve the api with Echo

• main.go

Test locally the API

Shell-1

Check environment variable BFF_PROJECT_ID to point to dev of qa project depending on test context

export BFF_PROJECT_ID="projectId"

go run main.go

Shell-2

curl 'localhost:8080/consolebff/v1/assetnames/now/days/-1'
curl 'localhost:8080/consolebff/v1/timelines/now/days/-1/asset?assetName=//bigquery.googleapis.com/projects/brunore-rces-autofix-chg-001/datasets/auto_test_us_central1_2022_11_23T11_50_03_183841451plus01_00'

Build locally the docker image

make packbuild

Test locally the docker image

Shell-1

make dockerrun

Shell-2

curl localhost:8081/consolebff/v1/assetnames