Code Monkey home page Code Monkey logo

userapi's Introduction

User API

Build Status

A rest API exposing User resources through standard REST endpoints.

This is using Spring MVC running on a spring-boot application. This is using in-memory Mongo database since seems enough for the complexity and expected workload.

Features:

  • CI made with travis
  • Code quality -> Using checkstyle, findbugs, and JaCoCo
  • Allow to build docker image for local testing

TODO:

  • Better API documentation
  • Smaller container using "alpine" or other approaches
  • Better warning suppressions
  • Publish into dockerHub
  • Deployment into cloud from travis
  • JavaDoc

Why MongoDb?

Although not a big fan of MongoDb seemed good for the purpose. I also considered CouchDb in combination with Spring Data CouchBase or H2 in combination with jOOQ, or Spring Data JDBC.

Usage:

Build: mvn clean install docker:build

Start: docker-compose up

API Usage

Get All Users: curl -X GET http://127.0.0.1:8080/user

Create New User: curl -X POST -H "Content-Type: application/json" -d "{"name":"user1", "email":"[email protected]", "phone":"0034666666666"}" http://127.0.0.1:8080/user

Update User Name: curl -X PUT -H "Content-Type: application/json" -d "{"name":"user1", "email":"[email protected]", "phone":"0034666666666"}" http://127.0.0.1:8080/user/{user_id}

userapi's People

Contributors

blacar avatar

Watchers

Bruno Oliveira Moreno 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.