Giter VIP home page Giter VIP logo

server's Introduction

BarcodeAPI.org

The BarcodeAPI.org web server was designed to provide an easy to use barcode generation API via the HTTP protocol for use in external / mobile applications where generation libraries might not exist or resources limited; the WebUI is also designed to be responsive such that users may generate barcodes to be scanned directly from their web browser or download the barcodes after testing them out.

Web Server

The server comes with a minimal set of static HTML and Javascript files that allow users to generate barcodes in their web browser with ease. The UI allows users to quickly download, print, or copy the images for use in other applications.

API Server

The server will generate a barcode for any content passed to the /api endpoint; this can be done using a web browser, fetched through a user script, or even simply with cURL.

curl https://barcodeapi.org/api/A_Barcode > gen.png

Automatic Code Type Detection

When calling the API endpoint without specifying an eplitit code type the server will make its best judgement as to which code type will be best suited for the supplied data.

curl https://barcodeapi.org/api/abc123
curl https://barcodeapi.org/api/auto/abc123

Defined Code Type

A list of all supported barcodes types is available by calling the /types/ endpoint; this will be a JSON Array containing details for each type including a regex format to prevalidate the date before a request.

Specific barcode types may be requested by adding the type string in the request URL:

curl https://barcodeapi.org/api/128/abc123
curl https://barcodeapi.org/api/qr/abc123

Docker Container

To build the image run:
docker build -t barcodeAPIServer .

And to run the container:
docker run -p 8080:8080 -v $(pwd)/config:/config barcodeAPIServer

Third-Party

BarcodeAPI.org is only made possible with the use of third-party software.

Jetty, Apache 2.0

  • The BarcodeAPI server was built around the Jetty web server framework.

Barcode4J, Apache 2.0

  • Barcode4J is an open source barcode generator; it is used for the generation of the following code types:

ZXing, Apache 2.0

  • ZXing is a barcode processing library that makes QR code generation possible.

License

Copyright 2020 BarcodeAPI.org

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

server's People

Contributors

dependabot[bot] avatar mclarkdev avatar timroemisch avatar tuxd avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

server's Issues

Server down

Possibly problems with SSL update?

Got following error when trying to access the server:

Proxy Error The proxy server could not handle the request GET /. Reason: Error during SSL Handshake with remote server

docker errors

I got two errors for docker, first one is a misspelling:

root@android-linux:~/docker/server# docker build -t barcodeAPIServer . ---> this I copied directly from the github readme

[+] Building 0.0s (0/0) docker:default
ERROR: invalid tag "barcodeAPIServer": repository name must be lowercase


this error I get when I run the docker:
root@android-linux:~/docker/server# docker run -p 9800:8080 -v $(pwd)/config:/config barcodeapiserver

Starting...

java.lang.NullPointerException: inStream parameter is null
at java.base/java.util.Objects.requireNonNull(Unknown Source)
at java.base/java.util.Properties.load(Unknown Source)
at com.mclarkdev.tools.liblog.LibLog.loadStrings(LibLog.java:70)
at org.barcodeapi.core.ServerLauncher.(ServerLauncher.java:72)
at org.barcodeapi.Launcher.main(Launcher.java:36)
Exception in thread "main" java.lang.NullPointerException
at org.barcodeapi.Launcher.invokeSystemShutdown(Launcher.java:67)
at org.barcodeapi.Launcher.main(Launcher.java:45)
note: when I run via jar command , it works .

Question about using

Hello! How can i use api in docker container? I need to generate aztec code from my shortcode and get barcode image

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.