DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Please enter at least three characters to search
Refcards Trend Reports
Events Video Library
Refcards
Trend Reports

Events

View Events Video Library

Zones

Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks

Last call! Secure your stack and shape the future! Help dev teams across the globe navigate their software supply chain security challenges.

Modernize your data layer. Learn how to design cloud-native database architectures to meet the evolving demands of AI and GenAI workloads.

Releasing software shouldn't be stressful or risky. Learn how to leverage progressive delivery techniques to ensure safer deployments.

Avoid machine learning mistakes and boost model performance! Discover key ML patterns, anti-patterns, data strategies, and more.

Related

  • Building and Integrating REST APIs With AWS RDS Databases: A Node.js Example
  • Low Code Approach for Building a Serverless REST API
  • How to Configure AWS Glue Job Using Python-Based AWS CDK
  • Building a Scalable ML Pipeline and API in AWS

Trending

  • Stateless vs Stateful Stream Processing With Kafka Streams and Apache Flink
  • Doris: Unifying SQL Dialects for a Seamless Data Query Ecosystem
  • Simplify Authorization in Ruby on Rails With the Power of Pundit Gem
  • Revolutionizing Financial Monitoring: Building a Team Dashboard With OpenObserve
  1. DZone
  2. Software Design and Architecture
  3. Integration
  4. Building a Rest API With AWS Gateway and Node.js

Building a Rest API With AWS Gateway and Node.js

With AWS Gateway, you can create RESTful APIs that expose your data and business to developers, who can then build great applications that consume your API.

By 
Derric Gilling user avatar
Derric Gilling
DZone Core CORE ·
Preet Kaur user avatar
Preet Kaur
·
Mar. 07, 23 · Tutorial
Likes (1)
Comment
Save
Tweet
Share
6.8K Views

Join the DZone community and get the full member experience.

Join For Free

AWS Gateway is a powerful tool for building APIs that scale to meet the demands of modern web and mobile applications. With AWS Gateway, you can create RESTful APIs that expose your data and business logic to developers, who can then build rich, interactive applications that consume your API.

REST API is an industry standard for building scalable, distributed web applications. With AWS Gateway, you can easily build a REST API that supports both GET and POST methods, as well as complex query parameters. You can also add support for other HTTP methods, such as PUT, DELETE, and HEAD.

Using AWS Gateway, you can quickly create APIs that are secure and robust. You can also use it to deploy your code to a production environment with minimal effort. Additionally, AWS Gateway allows for seamless integration with other AWS services, such as S3 and DynamoDB, enabling you to easily add complex functionality to your APIs.

Prerequisites

Before building a RESTful API with AWS Gateway, you should have the following in place:

  • Create an AWS account if you don’t have one already.
  • Log in to the AWS Management Console and navigate to the Amazon API Gateway service.
  • Amazon API Gateway service
    Click on “Create API” and select “REST API.”
REST API

Choose the protocol

  • Click on “Actions,” and define the resource and click “Create Resource.”
New Child Resource
  • Select the newly created resource and click on “Create Method.”

Create Method

GET Setup

  • Choose the HTTP verb (e.g., GET, POST, PUT, etc.) and click on the checkmark to create the method.
  • In the “Integration type” section, select “Lambda Function” and enter the name of the Lambda function you want to use to handle the API requests. Click on “Save” to create the API.
AWS Lambda function
  • Select Node from the Runtime Dropdown.
    Select Node

Code Example

JavaScript
 
let user = {
    firstName: "John",
    lastName: "Smith",
    location: "Bay Area"
}
export const handler = async(event) => {
    // TODO implement
    console.log(">>>> Inside Lambda Function....");
    if(event.httpMethod === "GET")
    {
        getUserRecord(event);
    }
    if(event.httpMethod === "POST")
    {
        createUserRecord(event)
    }
    const response = {
        statusCode: 200,
        body: JSON.stringify({
            user_details: user
        })
    };
    return response;
};
function getUserRecord (event) {
    const response = {
        statuscode: 200,
        body: JSON.stringify({
            user_details: user
        })
    };
    return response;
}
function createUserRecord(event) {
    const body = JSON.parse(event.body);
    const response = {
        statusCode: 200,
        body:JSON.stringify({
            message: "successfully created",
            details: body
        })
    };
    return response;
}


The code first creates an object called user that contains some properties like firstName, lastName, and location.

Then the handler function checks the HTTPMethod property of the event object; if it’s “GET,” it calls the getUserRecord function, and if it’s “POST,” it calls the createUserRecord function.

Both getUserRecord and createUserRecord functions take the event object as input and return the response object.

In the getUserRecord function, it creates a response object with a statusCode of 200 and a body that contains a JSON object with user_details property which is the user object created at the beginning.

In the createUserRecord function, it first parse the event.body which is a string, into a JSON object and then creates a response object with a statusCode of 200 and a body that contains a JSON object with message and details properties.

Deploy the API by clicking on “Actions” and selecting “Deploy API.”

Deploy API

Select a deployment stage (e.g., “prod” or “test”) and click on “Deploy.” Use the generated API endpoint to make requests to your API.

Running and Testing The Code in Postman

Now, our API is up and running. You can send a test HTTP request through Postman. By sending a request to your invoke URL, you should see a 200 OK status code. For this test, no request body is needed for the incoming request.

Request

Wrapping Up

With that, we’ve created a simple RESTful API using AWS Lambda. This code can then be expanded on as needed to build APIs for your applications.

API AWS Lambda REST Node.js AWS

Published at DZone with permission of Derric Gilling. See the original article here.

Opinions expressed by DZone contributors are their own.

Related

  • Building and Integrating REST APIs With AWS RDS Databases: A Node.js Example
  • Low Code Approach for Building a Serverless REST API
  • How to Configure AWS Glue Job Using Python-Based AWS CDK
  • Building a Scalable ML Pipeline and API in AWS

Partner Resources

×

Comments
Oops! Something Went Wrong

The likes didn't load as expected. Please refresh the page and try again.

ABOUT US

  • About DZone
  • Support and feedback
  • Community research
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Core Program
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 3343 Perimeter Hill Drive
  • Suite 100
  • Nashville, TN 37211
  • support@dzone.com

Let's be friends:

Likes
There are no likes...yet! 👀
Be the first to like this post!
It looks like you're not logged in.
Sign in to see who liked this post!