README
¶
The Functional Conformance Tool is an Open Source test tool provided by Open Banking. The goal of the suite is to provide an easy and comprehensive tool that enables implementers to test interfaces and data endpoints against the Functional API standard.
The supporting documentation assumes a technical understanding of the Open Banking ecosystem. An introduction to the concepts is available via the Open Banking Website.
To provide feedback, please see the CONTRIBUTING.md.
Release Notes
Release v1.7.6 (4th March 2024)
The release is called v1.7.6, an update to add proxy support, package and environment upgrades, add changes to manifests.
Download:
docker run --rm -it -p 127.0.0.1:8443:8443 "openbanking/conformance-suite:v1.7.6" |
DockerHub |
Setup Guide
Version table
| Release | Standard version |
|---|---|
| v1.7.2 | v3.1.11 |
| v1.7.0 | v3.1.10 |
| v1.6.12 | v3.1.9 |
Quickstart
Pull and run the latest (stable) tagged Docker image:
> docker run --rm -it -p 127.0.0.1:8443:8443 "openbanking/conformance-suite:v1.7.6"
or
> docker run --rm -it -p 8443:8443 "openbanking/conformance-suite:v1.7.6"
Prerequisites
The tool is compatible with the Open Banking UK R/W specification versions: 3.1.0, 3.1.1, 3.1.2, 3.1.3, 3.1.4, 3.1.5, 3.1.6, 3.1.7, 3.1.8, 3.1.9, 3.1.10, 3.1.11.
In order to run a container you'll need docker installed.
Support
For support on using the suite use the Open Banking Help Centre.
Licensing
This repository is subject to this MIT Open Licence. Please read our LICENSE.md for more information
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.
Useful links
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
report
Enum to json.UnmarshalJson and json.MarshalJSON taken from: https://gist.github.com/lummie/7f5c237a17853c031a57277371528e87 We might be able to use https://github.com/campoy/jsonenums - might do this after the package is tested.
|
Enum to json.UnmarshalJson and json.MarshalJSON taken from: https://gist.github.com/lummie/7f5c237a17853c031a57277371528e87 We might be able to use https://github.com/campoy/jsonenums - might do this after the package is tested. |
|
version
Package version contains version information for Functional Conformance Suite.
|
Package version contains version information for Functional Conformance Suite. |