README.md

openapi-box

Generate TypeBox types from OpenApi V3 IDL + End-to-end typesafe HTTP client library.

It works for TypeScript and JavaScript.

Install

$ npm install @geut/openapi-box @sinclair/typebox

Usage

1. Generate the schema from an OpenApi url (it can a be filepath too):

$ openapi-box https://petstore3.swagger.io/api/v3/openapi.json

2. Load your schemas into the End-to-end typesafe fetch client:

import { schema } from './schema.js'
import { createClient } from './src/client.js'

const client = createClient({
  schema,
  baseUrl: 'https://petstore.swagger.io/v2'
})

3. Enjoy your types + validations out of the "box" 😉:

Issues

🐛 If you found an issue we encourage you to report it on github. Please specify your OS and the actions to reproduce it.

Contributing

👥 Ideas and contributions to the project are welcome. You must follow this guideline.

License

MIT © A GEUT project