Skip to content

API to store sources of knowledge that serve as study material for students ๐Ÿ“š

License

Notifications You must be signed in to change notification settings

thalees/serveless-studies-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

62 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Serveless Studies Api ๐Ÿ“š

API to store sources of knowledge that serve as study material for students.

Description

Initially we understand that the main sources of study for a student are between links (such as a video, for example), articles, books, courses and podcasts.

With that in mind, we created a REST serverless API using Java and the AWS platform to store this data for each student.

Endpoints Documentation

This project has all its endpoints documented in Postman as a shared collection, to get a copy of its endpoints, just click the link below:

Run in Postman

If you want to see the documentation on the swagger, just click the button below to view:

Architecture

The architecture built for this project is designed below:

Among the components used are:

Api Gateway

Amazon API Gateway is an AWS service for creating, publishing, maintaining, monitoring and protecting REST and WebSocket APIs at any scale. Its role was to redirect all requests to specific lambdas whenever a request is made.

AWS Lambda

AWS Lambda allows you to run code without provisioning or managing servers. In this case, we use Java to perform the logic of each lambda (each lambda can be found in this repository in the handler classes)

We aimed to carry out the interactions with the database and return the results in a valid json format for the API Gateway through Lambda.

RDS

Amazon Relational Database Service (Amazon RDS) is a web service that facilitates the configuration, operation and dimensioning of a relational database in the AWS Cloud and for this components we have nothing special. RDS was responsible for storing data related to this API.

Authors

See the list of Contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

API to store sources of knowledge that serve as study material for students ๐Ÿ“š

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages