0% found this document useful (0 votes)
7 views10 pages

End-to-End REST API Development Report

The report details the creation of end-to-end REST APIs as part of a Practice School internship at Clapptron Technologies, focusing on backend development using Node.js and cloud deployment with AWS. It highlights the development of APIs for workflow automation and data transformation, emphasizing the use of TypeScript, serverless architecture, and integration with AWS Lambda. The project aimed to enhance technical skills while bridging the gap between academic knowledge and real-world application in API development.

Uploaded by

mdsaadi
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
7 views10 pages

End-to-End REST API Development Report

The report details the creation of end-to-end REST APIs as part of a Practice School internship at Clapptron Technologies, focusing on backend development using Node.js and cloud deployment with AWS. It highlights the development of APIs for workflow automation and data transformation, emphasizing the use of TypeScript, serverless architecture, and integration with AWS Lambda. The project aimed to enhance technical skills while bridging the gap between academic knowledge and real-world application in API development.

Uploaded by

mdsaadi
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

A REPORT ON

CREATING END TO END REST APIs

BY
Aman Tomy
ID NO: 2023A4PS1174G

AT
CLAPPTRON TECHNOLOGIES LTD
(BANGALORE)

BIRLA INSTITUTE OF
TECHNOLOGY AND SCIENCES,
PILANI
(JUNE,2025)
A REPORT ON
CREATING END TO END REST APIs

BY
Aman Tomy
ID NO: 2023A4PS1174G

Prepared in fulfillment of the Practice School-1


Course Nos. BITS C221/BITS C231/BITS C241

AT
CLAPPTRON TECHNOLOGIES LTD
(BANGALORE)

BIRLA INSTITUTE OF TECHNOLOGY AND


SCIENCES, PILANI
(JUNE,2025)
BIRLA INSTITUTE OF
TECHNOLOGY AND SCIENCE
PILANI (RAJASTHAN)
Practice School Division Station:
Station: Clapptron Technologies LTD Centre: Bangalore
Duration: May 26th To July 19th Date of Start: May 26th
Date Of Submission: July 12th
TITLE OF PROJECT: CREATING END TO END REST APIs
STUDENT
Name: Aman Tomy
ID NO: 2023A4PS1174G
Branch: Mechanical Engineering

EXPERTS
NAME: Sarthak
DESIGNATION: Software Development Engineer and Chief Technology Officer
a at Clappia
FACULTY
NAME: Shree Prasad M

Key Words:
REST API, Cloud Deployment, AWS, [Link], API Gateway, Backend Services

Project Areas:
Software Engineering, Cloud Computing, Web Development

Abstract:
This project focuses on the end-to-end process of developing and deploying
public APIs on cloud platforms. It begins with an in-depth understanding of
existing APIs, analyzing their structures, functions, and security layers.
Subsequently, multiple APIs were designed and implemented using modern
backend technologies such as [Link]. These were then deployed to cloud
environments using services like AWS API Gateway and Lambda, ensuring
scalability and accessibility. The project also covers monitoring and logging
using Postman and error handling. This initiative aimed to build efficient,
reliable, and reusable APIs for real-world application integration and service
extension.

Signature of Student: Signature of Faculty:


Acknowledgements
I would like to express my sincere gratitude to everyone who contributed to the
success of my Practice School-I (PS-I) internship.
Special thanks to the Practice School Division of BITS Pilani for enabling this
valuable industry exposure, and to my faculty instructor, Prof. Shree Prasad M,
for his consistent guidance and feedback.
I’m especially grateful to the team at Clappia for their mentorship, support, and
for creating a collaborative environment that enriched my learning in API
creation, backend development and cloud deployment.
Lastly, I thank my peers and everyone who supported me throughout this
journey. This experience has been pivotal in bridging theory with real-world
practice.
Introduction
After the midsem, I was assigned to continue building public API functionality
for other services like the Workflow Definition service which basically allows
the user to automate certain tasks which gets triggered after a particular action
by the App User, Also I was assigned to create a API that fetches the
submissions and transforms it into an Excel format. I had to learn how to access
lambda functions present in other services, I learnt more about the serverless
framework and the different appllications that come with it. I was also assigned
to learn more indepth about typescript and its syntax.
MAIN TEXT
1. Overview of the Project
The goal was to continue expanding the backend public API capabilities for
services like the Workflow Definition Service, which lets users automate tasks
triggered by actions performed by App Users. Another key task was developing
an API to fetch user submissions and transform them into an Excel format for
download. This required learning to interact with AWS Lambda functions across
different services, understanding the Serverless Framework, and deepening my
TypeScript knowledge.
MAIN APIs I worked on:
WorkflowDefinitionAPIs: AnalyticsAPIs:
1)AddWorkflow 1)AddChart
2)UpdateWorkflow 2)RemoveChart
3)RemoveWorkflow 3)ReorderChart
4)ReorderWorkflow 4)UpdateChart
5)GetWorkflows

2. Backend Implementation
Tech Stack: TypeScript, [Link], AWS Lambda & API Gateway, Git
The APIs were structured using a controller-service pattern. The Workflow
Definition API required handling triggers, conditions, and actions. The
Submissions-to-Excel API involved fetching data, transforming it to Excel using
libraries like xlsx, and returning it securely. TypeScript’s strict typing ensured
reliability and maintainability.

3. Serverless Deployment
Each API endpoint was deployed as a separate Lambda function, configured
through the Serverless Framework. API Gateway handled routing, CORS, and
security. I learned to access Lambda functions across services, enabling
integration between existing backend modules. Webpack and plugins helped
bundle code for deployment.
4. Development & Testing Workflow
APIs were tested locally using Postman, with automated tests written in Jest.
Git was used for version control and code reviews. I followed a feature-branch
workflow, ensuring clean integration with existing services.

5. Key Learnings
• Workflow Automation: How triggers and conditions work in the
Workflow Definition Service.
• Data Transformation: Generating downloadable Excel files from API data.
• Serverless: Practical usage of the Serverless Framework for deploying
scalable Lambda functions.
• Cross-Service Lambda Access: Calling and managing Lambdas from other
services securely.
• TypeScript: More in-depth syntax, interfaces, generics, and better typing
for robust code.

6. Real-World Applications
• Workflow Automation: Lets businesses automate tasks like sending
emails or notifications when a user submits a form.
• Excel Export: Enables admins to quickly download and analyze
submission data in spreadsheet format.

7. System Architecture Role


These APIs fit into a microservices environment where workflows run
independently of the main app. The Submission-to-Excel API bridges raw data
and user-friendly reporting. Both APIs are accessible to frontend clients and
other backend modules.

8. Broader Engineering Concepts


• Serverless: Cost-effective scaling without server management.
• Observability: Used CloudWatch for logs and debugging Lambda
executions.
• Security: Implemented input validation and secure API endpoints.

9. Scalability & Maintenance


The modular design and serverless deployment allow easy scaling and low
maintenance. Future improvements could include direct database queries,
more complex workflow actions, or scheduled automation.

10. Personal Impact


This experience gave me deeper backend knowledge, practical TypeScript skills,
and confidence working with serverless architecture and cross-service
integrations. It connected my academic background with real-world API
development.

Conclusion
Working on these public APIs pushed me to go beyond basic backend
development by exploring real-world automation, data transformation, and
cloud-native architectures. I strengthened my practical skills in TypeScript,
learned how to build and deploy serverless solutions using the Serverless
Framework, and gained valuable experience integrating AWS Lambda functions
across multiple services.
This project not only enhanced my technical abilities but also helped me
understand how robust, maintainable, and scalable APIs contribute to real
business workflows. Overall, it bridged the gap between what I learned in class
and what it takes to build production-ready, user-focused backend systems in
the industry.

You might also like