Code Monkey home page Code Monkey logo

aws-go-api's Introduction

Serverless API example.

A more realistic Serverless API template.

.
├── Makefile                    <-- Make to automate build
├── README.md                   <-- This instructions file
├── cmd                         <-- Used to run the code locally
├── db                          <-- DynamoDB database access code
├── handlers                    <-- HTTP handler code
├── lambda                      <-- Lambda entry point, used to run the code within AWS
├── log                         <-- Structured logging configuration
├── respond                     <-- HTTP traffic logging and standard API responses
└── serverless.yaml             <-- Serverless Framework configuration

Key features

  • Run as a Docker container by packaging up the output of the cmd directory, or run Serverless.
  • Uses DynamoDBLocal for local development.
  • Uses standard Go HTTP library - not tied in to a specific Serverless implementation.
  • JSON logging is provided by the "log" package. JSON logging allows metric extraction and analysis via CloudWatch Log Insights and CloudWatch Metrics.
  • Simple HTTP handler dependency injection.
  • JSON logging of HTTP response times.

Local development

Run DynamoDB local (via Docker), then run the cmd package.

  • make run-dynamodb (this blocks the Shell, so run it in a seperate process).
  • make run-local

Deployment

make deploy-dev will build the Go code and deploy it to AWS.

TODO

  • Add realistic examples of structured logging for business metrics.
  • Add examples of HTTP handler unit tests, not just database integration tests.
  • Add examples of JWT authorization decoding (ideally using Cognito).
  • Add example of CORS middleware configuration.
  • Add X-Ray configuration to allow tracing of request times downstream.

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.