Developing a web API with .NET Core on an AWS Lambda platform

Abstract

Opinnäytetyön tavoitteena oli kehittää toteutettavuusdemonstraatio dokumenttiarkistopalvelusta verkkorajapinnalla. Verkkorajapintaa käytettiin dokumenttien latauksien hallintaan. Palvelu toteutettiin asiakkaan antaman määrittelyn mukaisesti. Palvelu tuli rakentaa Amazon Web Service -ekosysteemiin käyttäen palvelimetonta tietojenkäsittelyä sekä .NET Core -ohjelmistokehystä. HTTP-pyynnöt oli autorisoitava OAuth 2.0 -teknologialla. Arkistodataa oli pystyttävä ylläpitämään autonomisesti ja säännöllisesti.

Rajapinta kehitettiin Amazon Web Servicen Lambda -alustalle käyttäen .NET Core 3.1 -ohjelmistokehystä. AWS Lambda käsitteli dokumentteja koskevat pyynnöt. Lambda -funktio tarjottiin AWS API Gatewayn välityksellä REST-rajapintana. Arkistoidut dokumentit tallennettiin Amazon Simple Storage Serviceen ja niiden oheistiedot tallennettiin AWS Relational Database Servicen PostgreSQL -tietokantaan. HTTP-pyyntöjen autorisointi implementoitiin OAuth 2.0- ja OpenID Connect -standardien mukaisesti.

Opinnäyteprojekti onnistui, ja tulokseksi saatiin määritysten mukaisesti toimiva konseptiversio. Joitakin määriteltyjä komponentteja korvattiin samankaltaisilla vastaavilla komponenteilla yksinkertaisemman rakenteen saavuttamiseksi. Komponentit käyttivät kuitenkin samoja protokollia ja tekniikoita kuin määrittelyissä vaaditutkin. Palvelua voidaan jatkokehittää tämän projektin tulosten pohjalta.

The goal of this thesis was to develop a proof-of-concept solution of a document archive service with a web API. The API would be used for managing the document uploads and downloads. The service would be built according to a specification given by the customer. The service had to be built on Amazon Web Service (AWS) ecosystem using serverless technologies and .NET Core framework. The HTTP requests had to be authorized using OAuth 2.0 technology. The system had to be able to maintain the archived data periodically and autonomously.

The API was developed on Amazon Web Service Lambda platform using .NET Core 3.1 framework. The AWS services were implemented as follows: The AWS Lambda function handles the document management. The Lambda function is available through an AWS API Gateway using REST API. The archived documents are stored on Amazon Simple Storage Service and the metadata of the documents are stored on AWS Relational Database Service using PostgreSQL database. The authorization of the requests was implemented using OAuth 2.0 and OpenID Connect standards.

The thesis project succeeded on building the proof of concept using the already mentioned methods to meet the specifications. Some of the required components were replaced with similar alternative components for the sake of simplicity but the same protocols and techniques as required were used. The project is viable for further development.