How to add custom middleware in Rooster?

Define a middleware map with enter and/or leave functions, as shown in the CORS example. Then, include it in your route definitions using the middleware list parameter, which can intercept requests or modify responses.

Rooster vs Cowboy for building Erlang APIs?

Rooster is a lightweight REST framework with composable routing, while Cowboy is a full-featured HTTP server supporting more protocols. Choose Rooster for simple, focused APIs; Cowboy for broader web applications with WebSockets or complex routing.

Does Rooster support WebSockets?

No, Rooster is designed specifically for REST APIs and does not include WebSocket support. For real-time features, you'd need to integrate additional libraries or use a different framework like Cowboy.

How to handle JSON requests in Rooster?

Rooster uses jsx for JSON parsing, so request bodies in JSON are automatically parsed into Erlang maps. Access the body in the request map, as demonstrated in the save_product handler example in the README.

Can I deploy Rooster in production with HTTPS?

Yes, Rooster supports HTTPS with SSL/TLS configuration using certificate files. Follow the SSL section in the README to set up secure connections, ensuring proper certificate paths and options.

Are there performance benchmarks for Rooster?

The README does not provide benchmarks, but being built on mochiweb, it should handle concurrent requests efficiently. For specific metrics, conduct your own tests or check community forums, as it's a lightweight solution.

rooster — Erlang REST Framework

What is rooster?

Rooster is an Erlang REST framework that simplifies building web APIs by providing composable routing, middleware support, and built-in authentication. It runs on top of mochiweb and handles HTTP verbs, request/response interception, and HTTPS configuration. The framework solves the problem of creating structured REST services in Erlang with minimal overhead.

Target Audience

Erlang developers building RESTful web APIs or microservices who want a lightweight, composable framework without the complexity of larger solutions.

Value Proposition

Developers choose Rooster for its simplicity, direct integration with mochiweb, and pragmatic feature set focused on routing and middleware. It offers a clean, minimalistic alternative to heavier Erlang web frameworks while providing essential REST capabilities.

Erlang REST framework

Use Cases

Best For

Building lightweight REST APIs in Erlang
Creating microservices with composable routing
Adding middleware for cross-cutting concerns like CORS or authentication
Prototyping web services quickly with minimal setup
Self-hosting secure APIs with HTTPS support
Integrating JSON parsing and basic authentication in Erlang applications

Not Ideal For

Applications requiring real-time features like WebSockets or server-sent events, as Rooster is focused solely on REST APIs.
Projects that need extensive built-in functionality such as database ORM, session management, or advanced templating.
Teams seeking a framework with a large community, extensive plugins, and comprehensive documentation for rapid development.
Web applications that require server-side HTML rendering, since Rooster is designed for API endpoints.

Pros & Cons

Pros

Composable Routing

Supports GET, POST, PUT, DELETE with both generic and nested route definitions, allowing flexible API structure as shown in the exports examples.

Middleware System

Provides enter and leave functions for intercepting requests and responses, enabling easy implementation of cross-cutting concerns like CORS and authentication.

Built-in Authentication

Includes a basic authentication module that integrates seamlessly with middleware, simplifying secure endpoint setup.

HTTPS Support

Allows SSL/TLS configuration with certificate options for secure connections, as detailed in the SSL section.

Lightweight and Minimal

Runs on mochiweb with minimal dependencies (jsx for JSON), reducing overhead and aligning with Erlang's pragmatic nature.

Cons

Limited Feature Set

Lacks advanced web features like WebSocket support, session handling, or built-in database connectors, which may require additional libraries.

Small Ecosystem

Relies on a narrow set of dependencies, so it has fewer third-party plugins and community resources compared to larger frameworks.

Manual Setup Required

Requires configuration with rebar3 and Erlang shell commands, which can be less intuitive for developers accustomed to more automated setups.

Sparse Documentation

The README is concise and may not cover all edge cases, potentially making it challenging for complex implementations without external resources.

What is rooster?

Target Audience

Erlang developers building RESTful web APIs or microservices who want a lightweight, composable framework without the complexity of larger solutions.

Value Proposition

Use Cases

Best For

Building lightweight REST APIs in Erlang
Creating microservices with composable routing
Adding middleware for cross-cutting concerns like CORS or authentication
Prototyping web services quickly with minimal setup
Self-hosting secure APIs with HTTPS support
Integrating JSON parsing and basic authentication in Erlang applications

Not Ideal For

Applications requiring real-time features like WebSockets or server-sent events, as Rooster is focused solely on REST APIs.
Projects that need extensive built-in functionality such as database ORM, session management, or advanced templating.
Teams seeking a framework with a large community, extensive plugins, and comprehensive documentation for rapid development.
Web applications that require server-side HTML rendering, since Rooster is designed for API endpoints.

Pros & Cons

Pros

Composable Routing

Supports GET, POST, PUT, DELETE with both generic and nested route definitions, allowing flexible API structure as shown in the exports examples.

Middleware System

Provides enter and leave functions for intercepting requests and responses, enabling easy implementation of cross-cutting concerns like CORS and authentication.

Built-in Authentication

Includes a basic authentication module that integrates seamlessly with middleware, simplifying secure endpoint setup.

HTTPS Support

Allows SSL/TLS configuration with certificate options for secure connections, as detailed in the SSL section.

Lightweight and Minimal

Runs on mochiweb with minimal dependencies (jsx for JSON), reducing overhead and aligning with Erlang's pragmatic nature.

Cons

Limited Feature Set

Lacks advanced web features like WebSocket support, session handling, or built-in database connectors, which may require additional libraries.

Small Ecosystem

Relies on a narrow set of dependencies, so it has fewer third-party plugins and community resources compared to larger frameworks.

Manual Setup Required

Requires configuration with rebar3 and Erlang shell commands, which can be less intuitive for developers accustomed to more automated setups.

Sparse Documentation

The README is concise and may not cover all edge cases, potentially making it challenging for complex implementations without external resources.

rooster

What is rooster?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

rooster

What is rooster?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?