Export Directory forms API service
A service with a write-only API for submitting schemaless JSON documents that represent a form submission, and then perform an action such as creating zendesk tickets, sending emails, etc.
| directory-ui-buyer | directory-ui-supplier | directory-ui-export-readiness |
|---|---|---|
| directory-sso | directory-sso-proxy | directory-sso-profile |
For more information on installation please check the Developers Onboarding Checklist
API schema is available at paths:
Direct download (yaml) - openapi/
Swagger UI - openapi/ui/
Redoc - openapi/ui/redoc/
$ git clone https://github.com/uktrade/directory-forms-api
$ cd directory-forms-api
$ virtualenv .venv -p python3.9
$ source .venv/bin/activate
$ make install_requirements
Secrets such as API keys and environment specific configurations are placed in conf/env/secrets-do-not-commit - a file that is not added to version control. To create a template secrets file with dummy values run make secrets.
| Command | Description |
|---|---|
| make clean | Delete pyc files |
| make pytest | Run all tests |
| make pytest test_foo.py | Run all tests in file called test_foo.py |
| make pytest -- --last-failed` | Run the last tests to fail |
| make pytest -- -k foo | Run the test called foo |
| make pytest -- | Run arbitrary pytest command |
| make manage | Run arbitrary management command |
| make webserver | Run the development web server |
| make requirements | Compile the requirements file |
| make install_requirements | Installed the compile requirements file |
| make css | Compile scss to css |
| make secrets | Create your secret env var file |
https://github.com/uktrade?q=directory https://github.com/uktrade?q=great