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.

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.

Read more

Authentication and Authorization

Understand how to use authentication and authorization.

Read more

Middlewares

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

Read more

Monitoring and Logging

Learn how to have montoring and logging in Robyn.

Read more

Real Time Notifications

Learn how to have real time notification in Robyn.

Read more

Deployments

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

Read more

OpenAPI Documentation

Learn how OpenAPI docs are generate for your applications.

Read more

Api Docs

Installation

Start using Robyn in your project.

Read more

Getting Started

Start with creating basic routes in Robyn.

Read more

The Request Object

Learn about the Request Object in Robyn.

Read more

The Robyn Env file

Learn about the Robyn variables

Read more

Middlewares, Events and Websockets

Learn about Middlewares, Events and Websockets in Robyn.

Read more

Authentication

Learn about Authentication in Robyn.

Read more

Const Requests and Multi Core Scaling

Learn about Const Requests and Multi Core Scaling in Robyn.

Read more

CORS

CORS

Read more

Templating

Learn about Templating in Robyn.

Read more

Redirection

Learn how to redirect requests to different endpoints.

Read more

File Uploads

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

Read more

Form Data and Multi Part Form Data

Learn how to handle form data.

Read more

Websockets

Learn how to use Websockets in Robyn.

Read more

Code Organisation

Learn about Views and SubRouters in Robyn.

Read more

Exceptions

Learn how to handle exceptions in Robyn.

Read more

Scaling the Application

Learn how to scaled Robyn across multiple cores.

Read more

Advanced Features

Learn about advanced features in Robyn.

Read more

Multiprocess Execution

Learn about the behaviour or variables during multithreading

Read more

Direct Rust Usage

Learn about directly using Rust in Robyn.

Read more

GraphQL Support

Learn about GraphQL Support in Robyn.

Read more

OpenAPI Documentation

Learn how to generate OpenAPI docs for your applications.

Read more

Dependency Injection

Learn about Dependency Injection in Robyn.

Read more