Skip to content

Latest commit

 

History

History
82 lines (72 loc) · 2.96 KB

README.md

File metadata and controls

82 lines (72 loc) · 2.96 KB

Lambda

The code in this folder is an example of an api implementation that can run in AWS Lambda and that automatically validates the incoming request against the OpenAPI spec.

Running locally

npx ts-node src/index.ts

then access via browser to 'http://localhost:5001/v1/datetime' to quickly or refer to one of the examples below (PostMan or other tool to make requests can be used)

API datetime

$ curl --location 'localhost:5001/datetime'
{"result":"2024-03-06T18:53:22.983Z"}

API addition

$ curl --location 'localhost:5001/addition' --header 'Content-Type: application/json' --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' --data '{
    "first": 4,
    "second": 3
}'
{"result":7}

API subtraction

$ curl --location 'localhost:5001/subtraction' --header 'Content-Type: application/json' --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' --data '{
    "first": 3,
    "second": 5
}'
{"result":-2}

API multiplication

$ curl --location 'localhost:5001/multiplication' --header 'Content-Type: application/json' --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' --data '{
    "first": 3.1,
    "second": 5
}'
{"result":15.5}

API division

Since division is protected with IAM role, it will return 403 error since the context?.identity?.user is not present in the request when running locally.

$ curl --location 'localhost:5001/division' --header 'Content-Type: application/json' --data '{
    "first": 4,
    "second": 2
}'
{"title":"IAM auth is required","status":403}

To test locally set temporarily the validateSecurity to false in src/app.ts and build and run the server again. Unit tests already bypass this correctly and should be the main source of local testing.

Testing wrong calls

  • division is protected with iam role as an example, not sending the x-amz-security-token will return 500 error, as expected.
$ curl --location 'localhost:5001/division' --header 'Content-Type: application/json' --data '{
    "first": 4,
    "second": 2
}'
{"title":"'x-amz-security-token' header required","status":500}
  • sending wrong body
$ curl --location 'localhost:5001/subtraction' --header 'Content-Type: application/json' --data '{
    "first": 3,
    "third": 5
}'
{"title":"request/body must have required property 'second'","status":500}
  • sending wrong data type
$ curl --location 'localhost:5001/subtraction' --header 'Content-Type: application/json' --data '{
    "first": "3",
    "second": 5
}'
{"title":"request/body/first must be number","status":500}