Git Product home page Git Product logo

javasnipe's Introduction

Javasnipe

Build Status GitHub License Static Badge Static Badge

A modern and easy-to-use library for interacting with the Snipe-IT API written in Java.

Features

  • Asynchronous API interactions: Utilizes CompletableFutures for non-blocking API calls, enabling efficient handling of concurrent operations.
  • Simplified error handling: Leverages Optionals to handle null values gracefully, reducing boilerplate code and simplifying debugging.
  • No new frameworks required: Built with standard Java classes to minimize the learning curve and integration complexity, ideal for projects looking to avoid dependency on heavy frameworks.
  • Accessibility for all skill levels: Designed to be straightforward for developers of any skill level.

Implementation Status

Javasnipe is a work in progress. See below for what is, and is not implemented.

Currently Implemented

  • Assets (/hardware, fully implemented)

Partially Implemeneted

  • Custom fields (able to get/set data for assets, cannot use API endpoint)
  • Companies (missing most fields, cannot use API endpoint)
  • Locations (missing most fields, cannot use API endpoint)
  • People (/users, missing most fields, cannot use API endpoint)
  • Status Labels (statuslabels, missing most fields, cannot use API endpoint)
  • Models (missing most fields, cannot use API endpoint)
  • Licenses (missing most fields, cannot use API endpoint)
  • Categories (missing most fields, cannot use API endpoint)
  • Manufacturers (missing most fields, cannot use API endpoint)
  • Suppliers (missing most fields, cannot use API endpoint)

Not Yet Implemented

  • Fieldsets (/fieldsets)
  • Accessories (/accessories)
  • Consumables (/consumables)
  • Components (/components)
  • Asset Maintences (/maintenacnes)
  • Departments (/departments)
  • Groups (/groups)
  • Settings (/settings/*)
  • Reports (/reports/activity)

Design

Many objects within the Snipe-IT API have different variants: one variant is used when the object is assigned to other objects, and another is used when the object is configured and created.

For example, the Company object assigned to an Asset is different from the Company object used in the configuration.

API wrappers, like Javasnipe, have two options to handle this:

  1. Combine both variants into one JavaBean, or
  2. Split them into separate JavaBeans.

Javasnipe chose option B because it is more straightforward to work with and develop. The objects assigned to assets, people, etc., are named like Company, while the configuration objects are named like ConfigurableCompany.

javasnipe's People

Contributors

sidpatchy avatar

Stargazers

 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.