simbld-http

🆕 Changelog (Version 0.2.1)

• New Feature: Cookie Management

Added helpers to include cookies directly in responses

ok_with_cookie: Generate an OK response with an attached cookie. bad_request_with_cookie: Generate a Bad Request response with an attached cookie.

• New Feature: Dynamic Headers

Added helpers to dynamically add custom headers in responses

ok_with_headers: Generate an OK response with custom headers. bad_request_with_headers: Generate a Bad Request response with custom headers.

• Middleware Improvement:

The middleware now adds

x-status-description: A description associated with the HTTP status code. x-response-time-ms: The request processing time in milliseconds.

📚 Complete Documentation and Examples

Complete examples, including detailed use cases and advanced integrations, are available in the project's GitHub repository (https://github.com/simbld/simbld-http/tree/main/examples).

Included Examples

• Basic Usage: An introduction to using simbld-http.

• Middleware Integration: Demonstration of integration into an Actix Web server with custom middleware.

• Response Helpers: Using helpers to create responses with cookies or custom headers.

🌟 Simbld-HTTP (v0.1.0)

Simbld-HTTP is a modular and comprehensive Rust library designed for managing HTTP response codes. Whether you're building APIs, handling custom response codes, or integrating middleware, Simbld-HTTP provides an organized and extensible framework to simplify your workflow.

✨ Key Features

Support for Standard and Custom HTTP Codes:

Handles all standard HTTP response families: 1xx to 5xx. Extends with custom families: 6xx, 7xx, and 9xx. Includes detailed descriptions for every status code.

Extensive Utilities:

JSON and XML response formatting. Helpers for paginated and generic HTTP responses. Middleware integration for Actix Web.

Easy Extensibility:

Add new families or custom helpers with minimal effort.

🚀 Why Choose Simbld-HTTP?

Developer-Friendly: Intuitive API with detailed documentation. Modular Design: Use only the parts you need for your project. Future-Proof: Easily extend to accommodate evolving HTTP standards and custom needs. Battle-Tested: Includes robust tests to ensure reliability.

📦 Installation

Add Simbld-HTTP to your ``Cargo.toml:

[dependencies]
simbld-http = "0.2.0"

📚 Documentation

Local Documentation

Run the following command to generate and open the documentation:

cargo doc --no-deps --open

This will

• Generate detailed API documentation from inline comments (///).
• Display all public modules, enums, and methods.

Online Documentation

The full documentation will be available on docs.rs after publishing. Stay tuned for updates!

🔧 Usage Examples

Basic Usage

use simbld_http::responses::ResponsesTypes;

let response = ResponsesTypes::Success(ResponsesSuccessCodes::Ok);
println!("Code: {}, Description: {}", response.to_u16(), response.description());

Retrieve a Crawler Code

use simbld_http::responses::ResponsesCrawlerCodes;
use strum::EnumProperty;

fn main() {
    let code = ResponsesCrawlerCodes::ParsingErrorHeader;
    println!(
        "Code: {}, Description: {}",
        code.to_u16(),
        code.get_str("Description").unwrap()
    );
}

Run the example with

cargo run --example usage

Using the Middleware

cargo run --example middleware_usage

Test the middleware response with curl

curl -i http://127.0.0.1:8080/

⚙️ Structure of Families

🤝 Contributing to Simbld-HTTP

We welcome contributions to Simbld-HTTP! Help us make this library the go-to solution for HTTP response code management in Rust.

1 Fork this repository

2 Clone your fork

git clone git@github.com:<your-username>/simbld-http.git

3 Create a branch for your changes

git switch -c feature/<your-feature-name>

4 Test your changes

cargo test

5 Open a pull request

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

🛠️