Custom Ktor Rest API

The project

The purpose of the project is to create custom Rest API using Ktor,

populate it and use the data via showcase application.

Custom Rest Api

The custom rest api is create with Ktor and populated with simple data -
computer images and information about their processors.

• Build system used is Gradle Kotlin.

• Engine is Netty

• Pluggins for specific backend bahaviour

  • Rounting - to define routes for response
  • Static Content - allow application to call a specific road
  • Content Negotiation - for automatic Json parsing of API response
  • Call Logging - log client request to the server
  • kotlinx.serialization - handles JSON serialization

Showcase Application

The simple showcase Android application is created with JetPack Compose.
The whole app is just main screen with ImageView, TextViews and a Button.
When the button is clicked, application performed a call to the Custom Ktor Rest Api
and retreive the data - information about a random computer. Than just populate
the ImageView and the TextViews with the data

Project characteristics and tech-stack

This project takes advantage of best practices, many popular libraries and tools in the Android ecosystem. Most of the libraries are in the stable version unless there is a good reason to use non-stable dependency.

• Tech-stack

  • 100% Kotlin + Coroutines - perform background operations
  • Retrofit - networking
  • Jetpack
    • StateFlow - notify views about database change
    • Lifecycle - perform an action when lifecycle state changes
    • ViewModel - store and manage UI-related data in a lifecycle conscious way
  • Hilt - dependency injection
  • Coil - image loading library

• Modern Architecture

  • Clean Architecture (at feature module level)
  • Single activity architecture using Navigation component
  • GitHub Actions
  • Automatic PR verification including tests, linters and 3rd online tools

• UI

  • JetPack Compose

• Gradle

  • Gradle Kotlin DSL

Getting started

There are a few ways to open this project.

IntelliJ Idea & Android Studio

1. IntelliJ Idea -> File -> New -> From Version control -> Git
2. Enter https://github.com/YosifKalchev/Ktor-Rest-Api/tree/main/RestApi into URL field an press Clone button 3.Android Studio -> File -> New -> From Version control -> Git
3. Enter https://github.com/YosifKalchev/Ktor-Rest-Api/tree/main/ComputersApp into URL field an press Clone button

Command-line + IntelliJ Idea & Android Studio

1. Run https://github.com/YosifKalchev/Ktor-Rest-Api.git command to clone project
2. Open IntelliJ Idea and select File | Open... from the menu. Select RestApi folder in cloned directory and press Open button.
3. Open Android Studio and select File | Open... from the menu. Select ComputersApp folder in cloned directory and press Open button.

NOTE: You need to run the RestApi first

Author