Giter Club home page Giter Club logo

opendata-client's Introduction

Note: current master version is 2.0.0-SNAPSHOT. We are changing the Java APIs to be more flexible and user-friendly. This README is valid for 1.X only.

Java client for JCDecaux Open Data

This project is a simple client library for JC Decaux Open Data. In order to use this API, you need to get a key at http://developer.jcdecaux.com.

Get it

JCD Open Data Client is available in Maven Central repository.

<dependency>
    <groupId>com.jcdecaux.opendata</groupId>
    <artifactId>opendata-client</artifactId>
    <version>1.1.0</version>
</dependency>

Features

Note: The client is thread-safe.

Bike sharing system

// ...
import static com.jcdecaux.opendata.client.vls.v1.VLSClient.vlsClient;

public class MyClass {

  private static final String apiKey = "xxxxx";

  public void myMethod() {
    // Get all stations
    List<StationDTO> all = vlsClient.getStations(apiKey, null);

    // Get all contracts
    List<ContractDTO> c = vlsClient.getContracts(apiKey);

    // Get all stations for one contract (Paris)
    List<StationDTO> p = vlsClient.getStations(apiKey, "Paris");

    // Get one station of Paris
    StationDTO s = vlsClient.getStation(apiKey, "Paris", "35010");
  }

}

Roadmap

We will update this client according to updates to our Opendata API

License

This software is licenced under the Apache Software License v2.0, you can find it in the LICENCE file.

opendata-client's People

Contributors

rsertelon avatar joseripla avatar

Watchers

James Cloos avatar Robin Penea avatar Nicolas Poirier avatar

Forkers

joseripla

opendata-client's Issues

Spring Client

Spring is a nice DI framework.

I plan to add a opendata-client-spring module that will wrap the opendata-client-jaxrs one.

This will be configurable via a properties file.

I'm wondering if the default behaviour can be overridden by configuration for users that might want not to add another config file to their app.

Create an Android client

This client library works well in JEE apps, as it is based upon JAX-RS and RESTeasy.

I was thinking about Android developers who might want to include our data into their apps. It would be nice if they could use this library too.

Might do this tonight.

Proxy configuration

Users might need to make their requests through a (corporate) proxy.

To that end, we should add proxy support.

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.