Skip to content

Files

Latest commit

4077e44 · Feb 17, 2025

History

History
This branch is 1 commit ahead of, 121 commits behind CycloneDX/transparency-exchange-api:main.

spec

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Nov 18, 2024
Nov 20, 2024
Feb 17, 2025

TEA OpenAPI Spec

The OpenAPI 3.1 specification for the Transparency Exchange API is available in openapi.json.

Generating API Clients from OpenAPI Spec

We use the OpenAPI Generator with configuration per language/framework in the generators folder. An example is:

docker run \
    --rm \
    -v "$(PWD):/local" \
    openapitools/openapi-generator-cli \
    batch --clean /local/spec/generators/typescript.yaml

Preview Specs

Fire up the swagger-ui with Docker from the root of the repository:

docker run \
    -p 8080:8080 \
    -e SWAGGER_JSON=/koala/spec/openapi.json \
    -v $(pwd):/koala swaggerapi/swagger-ui

And browse to http://localhost:8080.