api

README

FogLight API Backend

• FogLight API Backend
  • Overview
  • OpenAPI Specification Development
    • Swagger Editor

Overview

1. API Gateway receives HTTP request from Go CLI client.
2. API Gateway forwards request to API backend Lambda.
3. API Backend Lambda queries DynamoDB tables/indexes and returns results back to GO CLI client.

OpenAPI Specification Development

Swagger Editor

• Run the docker commands below and open the Swagger editor in your browser at http://localhost/
• Copy the swagger-api.yaml file into the Swagger editor to make changes.
• Copy the updated swagger spec from your browser to the local swagger-api.yaml file.

docker pull swaggerapi/swagger-editor
docker run -d -p 80:8080 swaggerapi/swagger-editor

To docker build the server.

export GITHUB_USER={username}
export GITHUB_ACCESS_TOKEN={your_access_toke}
docker build --build-arg GITHUB_USER=$GITHUB_USER --build-arg GITHUB_ACCESS_TOKEN=$GITHUB_ACCESS_TOKEN  -t apiserver .

To docker run the server locally.

docker run --rm -it -p 8080:8080 apiserver

http://localhost:8080/default/ping