web-api-commander/README.md

1.7 KiB

RESO Commander

CodeFactor Java CI with Gradle

The RESO Commander is an OData client Java library and command-line client, as well as an automated RESO Certification testing tool.

Getting Started

To begin using the RESO Commander, choose one of the following topics:

RESO Certification

One of the Commander's primary uses is as an automated testing tool. This section explains how to run the following tests:

  • Data Dictionary 1.7
  • Data Dictionary Availability Report
  • IDX Payload 1.7
  • Web API Core 1.0.2

Command-Line OData Web API Tools

The RESO Commander contains command line tools for working with OData Web APIs. This section covers how to validate metadata, make requests, and generate sample requests for testing.

Web API Client Library

The RESO Commander offers a convenient wrapper around the Apache Olingo Java client for OData, with added support for OAuth2 Bearer Tokens and Client Credentials.

The client library can be used to fetch and validate metadata, fetch data, and perform other OData client tasks.

Docker

For those who prefer Docker, both the Command Line and Automated Testing Tools can be run in a Docker container.

Codegen

The RESO Commander may also be used to generate reference XML Metadata, DDL, database seeds, automated acceptance tests, reference server models, and to convert XML Metadata to Open API 3 format.