Skip to content

Sideko-Inc/sideko

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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