Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jmattheis committed Jun 25, 2021
1 parent 71c3963 commit 3c0caa8
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 14 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Changelog
### 2.0.0 (2021-06-25)
- Updated client & runner to be compatible with FACT-Finder NG 2.0
- Migrated to openapi-generator for client generation

### 1.3.2 (2017-08-03)
- Updated `required` documentation

Expand Down
45 changes: 31 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,49 @@
# FACT-Finder Java Client

This project should help you integrate [FACT-Finder](http://www.fact-finder.com/) into your own system, by demonstrating how to use the different
functionalities via the JSON based REST API.

This project should help you integrate
[FACT-Finder](http://www.fact-finder.com/) into your own system, by
demonstrating how to use the different functionalities via the JSON based REST
API.

## Usage

### Requirement
- Java 8
- As this project is using [gradle](https://gradle.org/), you need a plugin to import it into your IDE. [IntelliJ](https://www.jetbrains.com/idea/) does support this by default, when using [Eclipse](https://eclipse.org/) we recommend using the [Buildship Plugin](http://marketplace.eclipse.org/content/buildship-gradle-integration).

- Java 8
- As this project is using [gradle](https://gradle.org/), you need a plugin to
import it into your IDE. [IntelliJ](https://www.jetbrains.com/idea/) does
support this by default, when using [Eclipse](https://eclipse.org/) we
recommend using the [Buildship
Plugin](http://marketplace.eclipse.org/content/buildship-gradle-integration).

### Update client
For generating the swagger client the swagger-codegen needs to be executed inside the client directory.

For generating the client the openapi-codegen needs to be executed inside the
client directory.

[Download instructions](https://github.com/OpenAPITools/openapi-generator)

Example command:

```
java -jar /path/to/swagger-codegen.jar generate -l java -c swagger-java-configuration.json -i /path/to/factfinder-swagger.json
$ java -jar /path/to/openapi-generator-cli.jar generate -g java -c
swagger-java-configuration.json -i /path/to/factfinder-swagger.json --skip-validate-spec
```

### Project structure
This project consists of two modules, named client and runner.

The client module contains POJO-classes and all classes necessary to send requests to FACT-Finder via its JSON based REST API. Most of the module has been
generated using [swagger codegen](http://swagger.io/docs/swagger-tools/). Only the class `de.factfinder.client.UpdatingAuthKeyClient` was added manually to ensure the validity
of the auth key for each service call. Some dependencies were also added to the generated `build.gradle`. These dependencies are needed by the manually
created classes.
This project consists of two modules, named client and runner.

The second module, named runner, contains example classes using that client classes. Each `Runner*`-class is executable on it's own and demonstrates a different FACT-Finder functionality.
The client module contains POJO-classes and all classes necessary to send
requests to FACT-Finder via its JSON based REST API. The module was generated
using [openapi generator](https://github.com/OpenAPITools/openapi-generator).

The second module, named runner, contains example classes using that client
classes. Each `Runner*`-class is executable on it's own and demonstrates a
different FACT-Finder functionality.

#### `Settings`-class
Before you are able to run one of the `Runner*`-classes, you need to adjust the `de.factfinder.runner.Settings`-class according to the path and credentials of your FACT-Finder environment.

Before you are able to run one of the `Runner*`-classes, you need to adjust the
`de.factfinder.runner.Settings`-class according to the path and credentials of
your FACT-Finder environment.

0 comments on commit 3c0caa8

Please sign in to comment.