api-docs-icon

Automated API Documentation Deployments

The easiest way to automatically sync your API docs is to use the Sideko CLI in your CI/CD environment.

Here is an example flow

Set Sideko key as environment variable
export SIDEKO_API_KEY=sk_live-1234
Run the deployment pipeline
sideko api version create --name your-api --spec ./spec.yaml --version patch
# Deploy the documentation to preview
sideko doc deploy --name your-doc-project 
# Deploy the documentation to production
sideko doc deploy --name your-doc-project --prod