In addition to the standard uses of OpenAPI schema, the Hookdeck OpenAPI schema is used to generate our SDKS:
- Go SDK
- TypeScript SDK
- More SDKs to come...
This repository contains
- Hookdeck's Fern API Definition which lives in the OpenApi folder
- Generators (see generators.yml)
In order to make sure that the definition is valid, you can use the Fern CLI.
npm install -g fern-api # Installs CLI
fern check # Checks if the definition is valid
Generators read in your API Definition and output files or code (i.e. the TypeScript SDK Generator) and are tracked in generators.yml.
You can preview the generated code in the ./local/go/generated/hookdeck-go-sdk
directory by running the following command:
fern generate --group local
To validate your API, run:
npm install -g fern-api # only required once
fern check
To update your SDKs, run fern generate
.
npm install -g fern-api # only required once
fern generate --group node-sdk
This repository contains Github Actions that will trigger SDK generation. Check them out by navigating
to the Actions
tab and clicking Release TypeScript SDK
.