sideko-inc/sideko

Generate SDKs and docs for your API

Sideko, Inc.

Put the spotlight on your API

Website | Docs

Welcome to Sideko, the platform for creating REST API tools and documentation.

Use OpenAPI 3.x specifications to generate:

• SDKs with types, tests, authentication, and code snippets
• Mock servers that mimic the behavior of your API
• Hosted API Documentation that stays up to date automatically

Installation

Install via pip

pip install sideko-py

OR

Install via curl (macOS, Linux, Windows w/ WSL)

curl -fsSL https://raw.githubusercontent.com/Sideko-Inc/sideko/main/install.sh | sh

Usage

Login

You need a Sideko API Key to generate SDKs. Start generating free SDKs by either:

1. Signing up / logging in via the CLI, or
2. Signing up / logging in at app.sideko.dev (User Icon > API Keys)

sideko login
# Complete login via browser pop-up

Run sideko login --help to list all options.

The API key is read from (in order of priority):

• $PWD/.sideko
• $HOME/.sideko
• SIDEKO_API_KEY environment variable

Free tier

Generate an unmanaged SDK with "sideko sdk try"

Language	Supported
Python	✅
Ruby	✅
Go	✅
Typescript	✅
Rust	✅
C#	🚧
Java	🚧

sideko sdk try (your Swagger/OpenAPI spec) python

• The OpenAPI source can be a path to a local .json or .yaml file, a URL, or the raw spec as a string.
• Language options: python, typescript, ruby, rust, or go

Run sideko --help to list all options.

Enterprise features

Head over to the complete CLI Documentation Page for instructions on how to programmatically maintain your complete API toolset.

Excited about Sideko?

Reach us at [email protected]

Reference

• Complete CLI Documentation
• License
• Issues

sideko's Issues

Generation Bug [python]

Issue: Generation Bug

• OpenAPI spec is valid 3.x spec (confirm with swagger editor
• Spec file causing issue included

Describe the bug

Full output is:

❯ sideko sdk generate https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.1/speechtotext.json python -v
[2024-06-01T15:46:18Z DEBUG sideko::config] no config found at -----------------
[2024-06-01T15:46:18Z DEBUG sideko::config] loaded config from /home/myuser/.sideko
[2024-06-01T15:46:18Z INFO  sideko::cmds::generate] Generating Sideko SDK in python
[2024-06-01T15:46:18Z DEBUG sideko::cmds::generate] Loading OpenAPI spec from url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.1/speechtotext.json
[2024-06-01T15:46:18Z DEBUG sideko::utils] Checking for updates (CLI verion: 0.5.0)...
[2024-06-01T15:46:20Z DEBUG sideko::cli] Response returned unsuccessful status code: 400
[2024-06-01T15:46:20Z ERROR sideko::cli] API Error: Failed generating SDK. Re-run the command with -v to debug.

To Reproduce

• Language: python
• Upload or link to OpenAPI v3: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v3.1/speechtotext.json