API Documentation

Welcome to the Robyn API documentation. You'll find comprehensive guides and documentation to help you start working with Robyn as quickly as possible, as well as support if you get stuck.

We have divided the documentation into two parts: the Example Application and the API Reference.

Real World App Api Docs

Getting started

The Example Application is a simple web application that demonstrates how to use the Robyn API. It is a great place to start if you are new to Robyn.

The API Reference contains detailed information about the Robyn API. It is a great place to start if you are already familiar with Robyn and want to learn more about the API.

Example Application

Getting Started

Learn how to authenticate your API requests.

Authentication and Authorization

Understand how to use authentication and authorization.

Middlewares

Read about different kinds of Middlewares and how to use them.

Monitoring and Logging

Learn how to have montoring and logging in Robyn.

Real Time Notifications

Learn how to have real time notification in Robyn.

Deployments

Learn how to deploy your app to production and manage your deployments.

OpenAPI Documentation

Learn how OpenAPI docs are generate for your applications.

Installation

Start using Robyn in your project.

Getting Started

Start with creating basic routes in Robyn.

The Request Object

Learn about the Request Object in Robyn.

The Robyn Env file

Learn about the Robyn variables

Middlewares, Events and Websockets

Learn about Middlewares, Events and Websockets in Robyn.

Authentication

Learn about Authentication in Robyn.

Const Requests and Multi Core Scaling

Learn about Const Requests and Multi Core Scaling in Robyn.

CORS

Templating

Learn about Templating in Robyn.

Redirection

Learn how to redirect requests to different endpoints.

File Uploads

Learn how to upload and download files to your server using Robyn.

Form Data and Multi Part Form Data

Learn how to handle form data.

Websockets

Learn how to use Websockets in Robyn.

Code Organisation

Learn about Views and SubRouters in Robyn.

Exceptions

Learn how to handle exceptions in Robyn.

Scaling the Application

Learn how to scaled Robyn across multiple cores.

Advanced Features

Learn about advanced features in Robyn.

Multiprocess Execution

Learn about the behaviour or variables during multithreading

Direct Rust Usage

Learn about directly using Rust in Robyn.

GraphQL Support

Learn about GraphQL Support in Robyn.

OpenAPI Documentation

Learn how to generate OpenAPI docs for your applications.

Dependency Injection

Learn about Dependency Injection in Robyn.