https://github.com/sideko-inc/sideko
Generate SDKs and docs for your API
https://github.com/sideko-inc/sideko
api api-client documentation openapi openapi-generator openapi-spec openapi-specification openapi3 rest-api sdk swagger swagger-api swagger-codegen swagger-documentation
Last synced: about 1 month ago
JSON representation
Generate SDKs and docs for your API
- Host: GitHub
- URL: https://github.com/sideko-inc/sideko
- Owner: Sideko-Inc
- License: other
- Created: 2023-10-03T14:04:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-24T14:00:37.000Z (about 2 months ago)
- Last Synced: 2025-04-05T18:05:22.506Z (about 1 month ago)
- Topics: api, api-client, documentation, openapi, openapi-generator, openapi-spec, openapi-specification, openapi3, rest-api, sdk, swagger, swagger-api, swagger-codegen, swagger-documentation
- Language: Rust
- Homepage: https://sideko.dev
- Size: 690 KB
- Stars: 61
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Your API Ecosystem On Autopilot
## The single platform to generate an ecosystem for your APIs
Using OpenAPI 3.x specifications you can create:
- 🚀 **SDKs** with types, tests, authentication, and code snippets
- 🔄 **Mock Servers** that mimic API behavior
- 📚 **API Documentation** that stays up to date automatically
- 💻 **CLI Tools** for simple API interactions
## Installation
```bash
# 🍏 macOS
brew install sideko-inc/tap/sideko
# 🐍 python - pypi
pip install sideko-py
# 📦 js - npm
npm install -g @sideko/cli
# ⚡ curl
curl -fsSL https://raw.githubusercontent.com/Sideko-Inc/sideko/main/install.sh | sh
```
## Quickstart - Premium SDKs in Seconds
```bash
# authenticate
sideko login
# interactively create sdks
sideko sdk init
```
## Local Authentication
This CLI utilizes your computer's native secure store:
- macOS: Keychain
- Linux: keyutils
- Windows: Credential Manager
To authenticate locally run: ```sideko login```
## Authenticating in CI/CD
Set `SIDEKO_API_KEY` environment variable in CI/CD.
1. With your own API key run: `sideko account get-my-api-key`
2. With a service account [see documentation](https://docs.sideko.dev/organizations/service-accounts)
# Resources
- [📘 Complete CLI Reference Docs](./docs/CLI.md)
- [📝 Report an Issue](https://github.com/Sideko-Inc/sideko/issues/new?template=generation-bug.md)
- [⚖️ License](./LICENSE)
- Shell autocomplete: `sideko config autocomplete --shell (your shell)` (must run this command with each Sideko CLI update)
---
Legacy CLI Installations
```bash
# via curl
curl -fsSL https://raw.githubusercontent.com/Sideko-Inc/sideko/v0.10.2/install.sh | sh
# via pip
pip install sideko-py==0.10.2
```
