Giter Club home page Giter Club logo

sinwo2022's Introduction

Simple API written in Kotlin

This project work as an example of API that can be written in Kotlin. It allows you to make an order, create new customer, get information about customers and orders and also offers a very simple user authentication example.

Run Locally

Clone the project

  git clone https://github.com/Seba0855/sinwo2022.git

Go to the project directory

  cd sinwo2022

Run the project

  ./gradlew run

Use endpoints on 127.0.0.1:2137 or any other IP you specify in Application.kt

Alternatively, you can also deploy the image to Docker

In order to deploy, run:

  ./gradlew runDocker

API Reference

This example features SwaggerUI, so it can be used to review available API endpoints. It's available on /swagger

Get orders

  POST /order/new
Request Body - list Type Description
item String Required. Product name
amount Int Required. Amount of ordered products
price Double Required. Price per one item

Get customer by ID

  GET /customer
Query parameter Type Description
id Int User ID

sinwo2022's People

Contributors

seba0855 avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.