Skip to content

RESOStandards/web-api-commander

Repository files navigation

RESO Commander

CodeFactor Java CI with Gradle

VIEW ON GITHUB

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:

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

  • Data Dictionary
  • Web API Core

Note: Data Dictionary testing is now handled by the RESO Certification Utils command-line utility. The Commander still works for metadata validation, but will be retired in the near future and the new tools merged into this repository.

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.

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.

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

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.