Note
Read-only mirror of @hey-api/openapi-python from the hey-api monorepo. Issues, pull requests, and contributions go to the main repository.
“The ecosystem trusted by TypeScript developers is coming to Python codebases.”
— Lubos, Founder of Hey API
Manual • Issues • Contribute
The OpenAPI to Python code generator.
Generate production-grade SDKs and Pydantic models.
Part of the Hey API ecosystem.
- production-grade code that compiles
- runs in any Node.js 22+ environment
- accepts any OpenAPI specification
- core plugin for SDKs
- HTTP client for HTTPX
- highly customizable via plugins
- sync with Hey API Registry for spec management
Want to see your code in products used by millions?
Start with our Contributing guide and release your first feature.
Partners behind the future of API tooling. Become a sponsor.
|
|
|
scalar.com |
fastapi.tiangolo.com |
getunblocked.com |
|
|
|
The fastest way to use @hey-api/openapi-python is via npx
npx @hey-api/openapi-python -i hey-api/backend -o src/clientCongratulations on creating your first client! 🎉 You can learn more about the generated files on the Output page.
You can download @hey-api/openapi-python from npm using your favorite package manager.
npm install @hey-api/openapi-python -D -Epnpm add @hey-api/openapi-python -D -Eyarn add @hey-api/openapi-python -D -Ebun add @hey-api/openapi-python -DThis package is in initial development. Please pin an exact version so you can safely upgrade when you're ready.
We publish migration notes for every breaking release. You might not be impacted by a breaking change if you don't use the affected features.
Most people run @hey-api/openapi-python via CLI. To do that, add a script to your package.json file which will make openapi-python executable through script.
"scripts": {
"openapi-python": "openapi-python"
}The above script can be executed by running npm run openapi-python or equivalent command in other package managers. Next, we will create a configuration file and move our options from Quick Start to it.
You can also generate output programmatically by calling createClient() in a JavaScript/TypeScript file.
import { createClient } from '@hey-api/openapi-python';
createClient({
input: 'hey-api/backend', // sign up at app.heyapi.dev
output: 'src/client',
});@hey-api/openapi-python supports loading configuration from any file inside your project root folder supported by jiti loader. Below are the most common file formats.
import { defineConfig } from '@hey-api/openapi-python';
export default defineConfig({
input: 'hey-api/backend', // sign up at app.heyapi.dev
output: 'src/client',
});/** @type {import('@hey-api/openapi-python').UserConfig} */
module.exports = {
input: 'hey-api/backend', // sign up at app.heyapi.dev
output: 'src/client',
};/** @type {import('@hey-api/openapi-python').UserConfig} */
export default {
input: 'hey-api/backend', // sign up at app.heyapi.dev
output: 'src/client',
};Alternatively, you can use openapi-python.config.js and configure the export statement depending on your project setup.
You must set the input so we can load your OpenAPI specification. It can be a path or URL, object containing a path or URL, or an object representing an OpenAPI specification. Hey API supports all valid OpenAPI versions and file formats.
If you use an HTTPS URL with a self-signed certificate in development, you will need to set
NODE_TLS_REJECT_UNAUTHORIZED=0in your environment.
You must set the output so we know where to generate your files. It can be a path to the destination folder or an object containing the destination folder path and optional settings.
You should treat the output folder as a dependency. Do not directly modify its contents as your changes might be erased when you run
@hey-api/openapi-pythonagain.
We parse your input before making it available to plugins. While configuring the parser is optional, it's the perfect place to modify or validate your input if needed.
Plugins are responsible for generating artifacts from your input. By default, Hey API will generate Pydantic models and SDK from your OpenAPI specification. You can add, remove, or customize any of the plugins. In fact, we highly encourage you to do so!
Clients are responsible for sending the actual HTTP requests. We default to HTTPX client if you're generating SDKs, but you can choose a different option from the available clients.
The following clients are roadmap proposals and are not started yet. You can help us prioritize them by voting on GitHub.
Don't see your client? Build your own or let us know your interest by opening an issue.
These plugins help reduce boilerplate associated with third-party dependencies. Hey API natively supports the most popular packages. Please open an issue on GitHub if you'd like us to support your favorite package.
The following plugins are roadmap proposals and are not started yet. You can help us prioritize them by voting on GitHub.
Don't see your plugin? Build your own or let us know your interest by opening an issue.
You can learn more on the Migrating page.
Released under the MIT License.