Skip to content

Chat Service Back-end, using the ASP.NET Core framework

License

Notifications You must be signed in to change notification settings

hsandid/ChatService-BackEnd

Repository files navigation

Build Status

Chat Service - Back-End API

Description

Completed during the Spring 2019-2020 semester by Bassel Shurbaji and Hadi Sandid for the course EECE503e - Web Services in the Cloud .

The project's objective was to learn more about back-end development and CI/CD systems, using the ASP.NET Core framework and the Azure DevOps platform.

Features

The following microservices are available :

  • Profile Microservice

    • Uses Azure Table storage to store profile data
    • Model : Controller <=> Storage Layer
    • Logging available for each microservice event
  • Images Microservice

    • Uses Azure Blob storage to store profile images
    • Model : Controller <=> Storage Layer
    • Logging available for each microservice event
  • Conversations Microservice

    • Uses Azure DocumentDB to store conversations, and their related messages
    • DocumentDB allows support for pagination when fetching conversations or messages
    • Model : Controller <=> Service Layer <=> Storage Layer
    • Logging available for each microservice event

Testing

Integration tests, Unit tests, and Deployment tests are available for each microservice.

Requirements

The Storage/Logging components have been designed for use with the Azure Cloud Platform. For these component to work properly, you must configure the following environment variables :

  • Azure Table Storage & Azure Blob Storage

    • "AzureStorageSettings:ConnectionString" should be set to the connection string associated with your Azure Table & Azure Blob Container Storage resources
    • "AzureStorageSettings:ProfilesTableName" should be set to the name of the Azure Table you have created.
    • "AzureStorageSettings:ImagesBlobContainerName" should be set to the name of the Azure Blob container you have created.
  • Azure DocumentDB Storage

    • "DocumentDbSettings:PrimaryKey" should be set to the connection string associated with your Azure DocumentDB resource
    • "DocumentDbSettings:DatabaseName" should be set to the database name associated with your Azure DocumentDB resource
    • "DocumentDbSettings:CollectionName" should be set to the collection name associated with your Azure DocumentDB resource
    • "DocumentDbSettings:EndpointUrl" should be set to the endpoint URL associated with your Azure DocumentDB resource
  • Logging & Azure Insights

    • "ApplicationInsights:InstrumentationKey" should be set to the instrumentation key associated with your Azure Application Insights resource

API Documentation

All request/response bodies are in JSON format unless specified otherwise

Profiles Microservice

  • POST api/profile

    • Request Body : { "Username", "FirstName", "LastName", "ProfilePictureId" }

    • Response Body : { "Username", "FirstName", "LastName", "ProfilePictureId" }

  • GET api/profile/{username}

    • Request Body : None

    • Response Body : { "Username", "FirstName", "LastName", "ProfilePictureId" }

  • PUT api/profile/{username}

    • Request Body :
      { "FirstName", "LastName", "ProfilePictureId" }

    • Response Body : { "Username", "FirstName", "LastName", "ProfilePictureId" }

  • DELETE api/profile/{username}

    • Request Body : None

    • Response Body : { "Username" }

Images Microservice

  • POST api/images

    • Request Body : form-data with key 'file' and value

    • Response Body : { "ImageId" }

  • GET api/images/{imageId}

    • Request Body : None

    • Response Body : form-data with value

  • DELETE api/images/{imageId}

    • Request Body : None

    • Response Body : { "ImageId" }

Conversations Microservice

  • POST api/conversations

    • Request Body :

    { "Participants": [ "Username1", "Username2" ], "FirstMessage": { "Id", "Text", "SenderUsername" } }

    • Response Body : { "Id" "CreatedUnixTime" }
  • POST api/conversations/{conversationId}/messages

    • Request Body : { "Id", "Text", "SenderUsername" }

    • Response Body : { "Id" "Text" "SenderUsername" "UnixTime" }

  • GET api/conversations?username={username}&continuationToken={continuationToken}&limit={limit} &lastSeenConversationTime={lastSeenConversationTime}

    • Request Body : None

    • Response Body : { "Conversations" : [ "Id" "LastModifiedUnixTime" "Recipient":[ "Username", "FirstName", "LastName", "ProfilePictureId" ] ], "NextUri" }

  • GET api/conversations/{conversationId}/messages? continuationToken={continuationToken}&limit={limit} &lastSeenMessageTime={lastSeenMessageTime}

    • Request Body : None

    • Response Body : { Messages : [ "Text" "SenderUsername" "UnixTime" ], "NextUri" }

About

Chat Service Back-end, using the ASP.NET Core framework

Resources

License

Stars

Watchers

Forks

Packages

No packages published