Giter VIP home page Giter VIP logo

spring-rest's Introduction

spring-rest

A simple REST API using Spring Boot and MongoDB.

Requirements

  • Java8
  • Maven
  • Docker

How to Build

  • Run the following command in the project folder: mvn clean package dockerfile:build. This will build the project and create a new docker image with name fthbrmnby/spring-rest-demo.
  • Create a new Docker network bridge: docker network create {your-network-name}
  • Start a MongoDB container. Be sure to give your mongo container a name, you'll need it: docker run --name {your-db-name} --network {your-network-name} mongo.
  • Start the Rest API container: docker run --network {your-network-name} -p 8080:8080 -e SPRING_DATA_MONGODB_HOST={your-db-name} fthbrmnby/spring-rest-demo

Endpoints

  • Create a new entry in database

[POST] 8080/users/create

Sample Request

{
    "firstName": "Walter",
    "lastName": "Curtz",
    "salary": 5000
}
  • Get the user entry with the given id

[GET] 8080/users?userId={user-id}

  • List all the entries in database

[GET] 8080/users/all

  • Delete the user entry with the given id

[DELETE] 8080/users?userId={user-id}

spring-rest's People

Contributors

fthbrmnby avatar

Watchers

 avatar

Forkers

guoyu07

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.