Introduction

Sword is a web framework that enables building server-side applications in a structured and opinionated way.

It is currently under active development, so some features may change or be removed frequently. This documentation may undergo modifications until a stable version is reached. Once stable, version-specific documentation will be published.

Motivation

The core idea of Sword is to establish a development structure based on modules, similar to frameworks like Spring (Java) or NestJS (Node.js). Additionally, Sword provides a suite of tools and utilities commonly required in these types of frameworks:

• Configuration and environment variable management
• Standardized HTTP response formatting (JSON)
• Essential built-in middlewares (Interceptors)
• Dependency Injection (Automatic component construction)

What do we mean by "structured/opinionated"?

Building scalable web applications requires organizing code into well-defined layers and maintaining a clear separation of concerns.

If you are here, you have likely used Axum, a framework developed by the tokio-rs team. Axum offers a comprehensive set of features for web development; however, as your project grows, the codebase can become complex to maintain. You might find yourself repeatedly adding features to extend or simplify Axum's own functionality, which can lead to a difficult-to-maintain codebase over time.

For this reason, Sword leverages libraries from the tokio ecosystem to build a more organized and modular development structure, aiming to facilitate the scalability and maintainability of your Rust web projects.