The highest tagged major version is
README
¶
Form3 Go client library
A simple go client library for the Form3 REST APIs built with custom operation names and swagger templates for a cleaner interface.
This is ideal for:
- Calling the API interactively (e.g. investigating resources or testing new features).
- Scripting (e.g. multi-call investigation or cleanup scripts)
- Testing, particularly when multiple calls to the API are involved.
- Load Testing, with K6 integration for initiating the requests
What's included
A simple client library with:
- Automatic authentication and re-authentication based on environment variables
- Pre-populated request objects with configurable defaults
- Sensible operation naming
- A fluent API with reduced repetition compared with vanilla swagger-go generated clients
- All the power and flexibility of Go!
Getting started
For interactive usage we recommend using gore.
Environment variables
| Environment variable | Description |
|---|---|
| FORM3_HOST | Form3 host URL, e.g. https://api.form3.tech |
| FORM3_PUBLIC_KEY_ID | Public key ID for request signing |
| FORM3_PRIVATE_KEY | Private key in PEM format for request signing |
| FORM3_ORGANISATION_ID | Organisation ID |
| DEBUG | Output full HTTP calls and responses |
| FORM3_CLIENT_ID | Client ID for token based auth (deprecated) |
| FORM3_CLIENT_SECRET | Secret for token based auth (deprecated) |
Updating the client
Prerequisites
- yq
- Python 3 with
pyaml
Regenerate client
Tasks in the Makefile download and preprocess the latest API swagger version:
make install-swaggerto install go-swagger if not already installed.maketo regenerate the client files.
License
Copyright 2019-2021 Form3 Financial Cloud
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.
Directories