Giter VIP home page Giter VIP logo

phone-api's Introduction

Phone API

Functional Specification

Phone API has 1 endpoint /phones, which returns a couple of mobile phones like iPhone 7, Samsung Galaxy S7 etc. with some simple attributes like product image (just take some off of google images), title, description, color, price etc.

Technical Specification

Gradle 3 java web application.

  • Spring boot (REST)
  • Jackson
  • HSQLDB

API documentation

Launch /swagger-ui.html resource.

Run from local

Build and run with

gradle clean build && java -jar ./build/libs/phone-api-1.0.1.jar

Run with docker

Image is published in docker hub

You can run it with docker

docker run --rm -p 8080:8080 luchoct/phone-api:1.0.1

Published port should be 8080 as that is the port used by phone-web website.

Create image and push image to registry

gradle build buildDocker

Changelog

  • 2017-06-13 Version 1.0 Initial version

Areas of improvement

  • Use HTTPs
  • Authenticate the client
  • Do not use an in-memory data store for production
  • Define production and stage environments

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.