Giter Club home page Giter Club logo

person-api's Introduction

CodeQL CI - Create Release and Publish

Getting Started:

Technology

Person API is a basic JAVA-Springboot implementation of a RESTful API with CRUD operations and an entry level authentication mechanism.

Below are the libraries used to achieve this.

  • Springboot
  • Spring Doc Open API
  • Spring Security
  • Spring Data JPA
  • H2 data base for local execution

Deployment

For deploying this application on any system, follow the below steps. Please ensure uninterrupted internet connection till the time your local docker image is prepared.

  • Clone or download this repository on your system.

  • Ensure Docker is running in your system.

  • Open terminal and navigate to the location where your clone/download is stored.

  • run docker build -t <TAG_NAME> .

    e.g. docker build -t dishant/person-api .

  • This will take few seconds to download the base and other required images from dockerhub and prepare this application's final image and tag it as <TAG_NAME>

  • Final image created will be identified as <TAG_NAME>:latest

  • run docker run -p 8080:8080 <TAG_NAME>:latest

    e.g. docker run -p 8080:8080 dishant/person-api

Test Application

For the sake of simplicity to run application in a more pleasing way, Spring Doc has been generated. Ones the application is deployed, you can access the Spring Docs on the following URL

http://<HOST_NAME>:<PORT_NUMBER>/persons/api/v1/swagger-ui/index.html?configUrl=/persons/api/v1/docs/swagger-config#/person-controller

So if you run your application on local on the above 8080 port then the URL will turn out to be

Person API Spring Doc URL

Admin User:

  • User: admin.dishant
  • Pass: password
  • Access: Management, Health, GET, POST, PUT, DELETE

User:

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.