Tooling and OpenAPI

​

Import into an API client

​

Postman or Insomnia

1. Download the JSON or YAML file.
2. Import it as an OpenAPI specification.
3. Configure https://api.jobhandy.io/v1 as the server if the client does not select it automatically.
4. Store X-API-Key in the client’s protected environment, not in a shared collection export.
5. Add X-Tenant-ID only where needed.
6. Disable or remove example secrets before sharing the workspace.

​

Generate a client

npx @openapitools/openapi-generator-cli generate \
  -i jobhandy-public-api.openapi.json \
  -g typescript-fetch \
  -o generated/jobhandy

npx @openapitools/openapi-generator-cli generate \
  -i jobhandy-public-api.openapi.json \
  -g csharp \
  -o generated/jobhandy-csharp

​

Contract validation in CI

• OpenAPI 3.1 validation succeeds
• all $ref values resolve
• operationId values remain unique
• generated code compiles
• examples conform to schemas
• no unexpected breaking changes appear
• the production server remains https://api.jobhandy.io/v1
• no development or stage host is introduced into customer configuration

​

Pin the adopted contract

client release
OpenAPI info.version
file checksum
adoption date
generator and configuration
breaking-change review result