apitrary.jar

Maven parent project, which contains the Java apitrary Backend as a Service client and orm modules.

Getting Started

---

The apitrary.jar is broken down into 4 modules: apitrary-api, apitrary-api-client, apitrary-transport and apitrary-orm.

• The apitrary-api is a plain pojo implementation of the apitrary api schema.
• The apitrary-api-client uses the apitrary-api to fire requests against the apitrary API.
• The apitrary-transport is the parent module of several http transport wrapper implementations.
  • apitrary-transport-cxf enables support for apaches cxf client implementation
  • apitrary-transport-httpclient enables support for apaches httpclient implementation
  • apitrary-transport-javanet enables support for plain java.net http connections
• The apitrary-orm module is devided into 2 submodules.
  • The apitrary-orm-core module brings everything to you to CRUD your entities, map your business POJOs to JSON and vice versa and fire higher cascading operations.
  • The apitrary-orm-codec module provides en- and decoding of your entity's properties (ex. images to base64 and vice versa).

The latest apitrary artifacts are published to maven central. Bringing apitrary into your project should be as simple as adding the following to your maven pom.xml file:

  <dependencies>
    <dependency>
      <groupId>com.apitrary</groupId>
      <artifactId>apitrary-api-client</artifactId>
      <version>1.0.0</version>
    </dependency>

    <!-- it is necessary that you define the way you want to talk to apitrary! -->
    <dependency>
      <groupId>com.apitrary</groupId>
      <artifactId>apitrary-transport-httpclient</artifactId>
      <version>1.0.0</version>
    </dependency>
  </dependencies>

Requirements

---

You will need following:

• Java JRE 1.6+ (Download page)
• Java JDK 1.6+ (Download page)
• Apache Maven 2.0+

Install via your package manager, otherwise get the libraries.

Descriptions can be found here:

For Maven: Building a Project with Maven

How to setup this project?

---

1. Clone the apitrary.jar project

    $ git clone https://github.com/denisneuling/apitrary.jar.git
   

2. Change into the directory:

    $ cd apitrary.jar
   

3. Run maven:

    $ mvn install # fetch all dependencies and build the project
   

4. Start hacking.

Which modules does this project contain?

---

• apitrary-api
• apitrary-api-client
• apitrary-transport
• apitrary-orm

Interested into somewhat like build stability?

---

• Have a look at Apitrary.jar at Travis CI

What about interface documentation? - Javadoc.

---

• apitrary-api Javadoc
• apitrary-api-client Javadoc
• apitrary-orm-core Javadoc
• apitrary-orm-codec Javadoc
• apitrary-transport-httpclient Javadoc
• apitrary-transport-javanet Javadoc
• apitrary-transport-cxf Javadoc

Note: The Javadoc will be exported once a release, so it might differ from the current master branch implementation.