XOF API client v1.0

Client to use the XOF API in Kotlin/Java(11+) applications

Usage

In plain Kotlin applications

1. Download the latest xof-client-core JAR via Maven:

   <dependency>
     <groupId>com.github.danzx.xof</groupId>
     <artifactId>xof-client-core</artifactId>
     <version>${version}</version>
   </dependency>

   or Gradle:

   implementation "com.github.danzx.xof:xof-client-core:${version}"

2. Create a new instance of the client with the default configuration

   val client = XofClient.newInstance()

   Or by overriding the default configuration

   // Default values
   val client = XofClient.newInstance(config {
       baseUrl = "https://xof.herokuapp.com/api/v1/"
       logger { level = NONE }
       cache { size = 10.megabytes }
       connection {
         readTimeout = 10.seconds
         writeTimeout = 10.seconds
         connectTimeout = 10.seconds
         callTimeout = 0.nanoseconds
       }
     })

3. Use the client

   if (client.isServiceAvailable) {
     val user = client.usersApi.getByUsername("username")
   }

In Spring Boot applications

1. Download the latest xof-client-spring-boot-starter JAR via Maven:

   <dependency>
     <groupId>com.github.danzx.xof</groupId>
     <artifactId>xof-client-spring-boot-starter</artifactId>
     <version>${version}</version>
   </dependency>

   or Gradle:

   implementation "com.github.danzx.xof:xof-client-spring-boot-starter:${version}"

2. Inject the client in your bean

   @Autowired lateinit var client: XofClient

3. Use the client

   if (client.isServiceAvailable) {
     val user = client.usersApi.getByUsername("username")
   }

Optionally you can override the default configuration using the application.properties

# Default values
xof-client.base-url=https://xof.herokuapp.com/api/v1/
xof-client.connection.read-timeout=10s
xof-client.connection.write-timeout=10s
xof-client.connection.connect-timeout=10s
xof-client.connection.call-timeout=0ns
xof-client.logger.enabled=false
xof-client.logger.level=none
xof-client.cache.enabled=false
xof-client.cache.size=10MB

Project info

Modules

• xof-client: contains the client abstract API and SPI contract
• xof-client-core: implements the client (currently with Retrofit)
• xof-client-spring-boot-starter: Spring auto-configuration to integrate the client into Spring applications

Build the project

$ ./gradlew clean build

License

Copyright 2020 Daniel Pedraza-Arcega

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.