Code Monkey home page Code Monkey logo

device-manager-api's Introduction

Device Manager API

Simple Spring Boot REST API for creating, updating, and finding devices by serial number and machine code.

Endpoints

Method Type Path Description
GET /devicemanager/devices getAllDevices
POST /devicemanager/devices addDevice
GET /devicemanager/devices/machineCode/{machineCode} findByMachineCode
PUT /devicemanager/devices/machineCode/{machineCode} updateByMachineCode
GET /devicemanager/devices/serialNumber/{serialNumber} findBySerialNumber
PUT /devicemanager/devices/serialNumber/{serialNumber} updateBySerialNumber

How to Run

If you use an IDE, I'm assuming you won't need instructions for how to run it...

These instructions will be for running from the command line.

  1. Clone repository
  2. From the command line, navigate to project root folder
  3. Run Maven install
mvn install
  1. Start Spring Boot app (application runs on portt 8080 by default)
mvn spring-boot:run

Testing API with Swagger

After starting the API, navigate to http://localhost:8080/devicemanager/swagger-ui/ to test the API using Swagger.

You should see something like this:

device-manager-api's People

Contributors

jimmynguyen avatar

Watchers

James Cloos avatar  avatar  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.