Quickstart
Build and deploy our first SDK in minutes
To get started you will need an API key for your account. Create one in your dashboard settings.
Initialize
This is not a production command. Make an install script!
Install using curl:
curl -L https://borea.dev/install.sh | bash
Verify the installation:
borea --version
You should see an output like this: Borea CLI: v.1.1.3
If not, rerun the script and verify again.
Configuring Borea is simple. We’ll walk you through the basics on how to generate and use our powerful borea.config.json file.
Run the init command
borea init
This will generate a default borea.config.json file that looks something like this:
{
"input": {
"openapi": ["<path_to_spec_or_URL>"]
},
"output": {
"clientSDK": "Formatted OpenAPI Title by default",
"models": "models",
"tests": true,
"xCodeSamples": false
},
"ignores": []
}
By default, SDKs and data models are generated. We highly recommend not changing this. Tests are a premium feature and are disabled by default, and will not work on the Hobby plan.
borea.config.json. You can overwrite the settings in the config file by passing the proper flags. For all options and flags, see configurationConfiguration options
input:openapi- The relative/absolute path or URL to your OpenAPI spec file (json and yaml supported)
output:clientSDK- The name of the SDK when generated. Default is the formatted title in your OpenAPI specmodels- The name of the folder to hold all the client modelstests- Enables test generation and running on regenerationxCodeSamples- Enables generation of x-Code-Samples to be used in you OpenAPI spec and documentation
ingores- Folders and files here will be ignored on regeneration, preserving any changes. Glob (gitignore) syntax
Generate
There are many things that Borea does not yet support out of the box like OAuth, webhooks, and websockets.
To implement these features, or any others you want, simply add the file or folder to the ignores field in borea.config.json.
Any changes you make to those files or folders will be preserved on regeneration.
{
"input": {
"openapi": ["<path_to_spec_or_URL>"]
},
"output": {
"clientSDK": "Formatted OpenAPI Title by default",
"models": "models",
"tests": true,
"xCodeSamples": false
},
"ignores": ["webhooks.py", "lib/auth"]
}
Deploy
Create a Remote Respository
Go to the remote hosting service you prefer and create a new repository.
For future compatability with Borea version control, we recommend GitHub.
Push your new SDK
git init
git add .
git commit -m "initial commit"
git branch -M main
git remote add origin <remote_repo_url>
git push -u origin main
Work in Progress 🚧 To deploy to PyPi, please follow this tutorial
Quickstart Resources
Configuration Guide
A full guide to configure the Borea generators, CI/CD pipeline, and deployment.
API Reference
The full documentation of our public API.