Giter VIP home page Giter VIP logo

springrest's Introduction

Build Status

Customer Profile management REST Application

This is a Spring Boot Application with a full-fledged REST API service exposed with Swagger 2.0 UI. It allows for CRUD operations on the customer profile information.

*This application is hosted on Microsoft Azure Cloud.**

Click the following link to access the DEMO

Default 2 users in the system and their corresponding details for Basic in-memory login

User Password
admin password
user password

Architecture Diagram

Architecture Page

Technology Stack

  • Spring Boot
  • Spring Rest
  • Spring JPA
  • Swagger 2.0
  • H2 in-memory DB
  • Docker Container
  • Open JDK 8
  • Maven 3

Build Instructions

If you need to run the project on Eclipse or IntelliJ following steps would help for a quick setup

  1. Open pom.xml with Intelij or Eclipse
  2. Run Main.java
  3. Open browser on http://localhost:8080/swagger-ui.html

Docker Run Command

If you require to directly run the service in docker environment then execute the following command to automatically pull and deploy locally from public docker cloud repository.

docker run -d -p 8080:8080 shouriendoc/springrest:1.0-SNAPSHOT

Integeration Tests

Semaphore is used to perform automatic continous integration LINK. The project is verfied for integrity using the Spring Boot Tester with Integration Tests written to ensure E2E working for each of the REST API.

Application Guide

  • The landing page for this application is the Swagger based 2.0 UI. Landing Page

  • Rest resources exposed to the user for invoking API's. The corresponding documentation detailing the request/response and the ability to invoke the apis is also provided by Swagger seamlessly. API Listing

  • Following is an example to invoke the REST API below. This is the REST API to obtain details of the customer for a particular customer ID. Invoke API

  • The REST response of the API as provided by Swagger. REST Response

springrest's People

Contributors

shourien 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.