Paralax.Docs.Scalar 1.0.436

dotnet add package Paralax.Docs.Scalar --version 1.0.436                
NuGet\Install-Package Paralax.Docs.Scalar -Version 1.0.436                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Paralax.Docs.Scalar" Version="1.0.436" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Paralax.Docs.Scalar --version 1.0.436                
#r "nuget: Paralax.Docs.Scalar, 1.0.436"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Paralax.Docs.Scalar as a Cake Addin
#addin nuget:?package=Paralax.Docs.Scalar&version=1.0.436

// Install Paralax.Docs.Scalar as a Cake Tool
#tool nuget:?package=Paralax.Docs.Scalar&version=1.0.436                

<div align="center">

Paralax Logo

Paralax Framework

.NET 9.0 Build Status NuGet Version Coverage Status

</div>


Overview

The Paralax Framework is a modern, powerful, and modular open-source .NET framework optimized for building microservice architectures. It provides essential components, including encryption, CQRS, logging, messaging, persistence, cloud integration, and HTTP services. Paralax is optimized for .NET 9.0 and integrates seamlessly into cloud-native environments, making it ideal for scalable and resilient distributed systems.

Whether you’re building microservices from scratch or extending existing services, Paralax offers a comprehensive toolkit that is both flexible and easy to integrate.


Key Features

  • Modular and Extensible: Tailor your microservices by using only the components you need.
  • Security-First: Offers encryption, hashing, signing, and secrets management out of the box.
  • Advanced CQRS and Event Sourcing: Full support for the Command-Query Responsibility Segregation (CQRS) pattern and event sourcing for scalable applications.
  • Message Brokering: Seamless integration with RabbitMQ, Kafka, and other message brokers.
  • HTTP & Web API: Robust HTTP client, server support, and API gateway integration.
  • Serialization: Built-in support for both JSON and binary serialization, crucial for optimized data transfer between microservices.
  • Cloud-Native: Optimized for Kubernetes, Docker, and other cloud platforms.
  • Observability: Built-in support for logging, metrics, and distributed tracing using OpenTelemetry and Jaeger.
  • Persistence: Ready-to-use integrations with MongoDB, Redis, and Consul for robust data storage solutions.
  • API Documentation: Integration with Swagger and ReDoc to generate comprehensive API documentation.

Table of Contents


Getting Started

Prerequisites

  • .NET 9.0 SDK or higher: Download .NET 9.0
  • A container platform like Docker or Kubernetes (for cloud-native applications).

Installation

You can install the framework and its core components via NuGet:

dotnet add package Paralax
dotnet add package Paralax.Auth
dotnet add package Paralax.CQRS
dotnet add package Paralax.Logging
dotnet add package Paralax.MessageBrokers

For specialized functionality HTTP, Web API, and message brokers:

dotnet add package Paralax.HTTP
dotnet add package Paralax.WebAPI
dotnet add package Paralax.MessageBrokers.RabbitMQ
dotnet add package Paralax.Tracing.Jaeger

Usage

Once installed, you can start configuring Paralax in your microservices project. Below is an example of configuring logging, tracing, and CQRS with RabbitMQ for message brokering.

public static void Main(string[] args)
{
    var builder = WebApplication.CreateBuilder(args);

    // Add Paralax components
    builder.Services.AddParalaxLogging();
    builder.Services.AddParalaxTracing();
    builder.Services.AddParalaxCQRS();
    builder.Services.AddParalaxMessageBrokerRabbitMQ();

    var app = builder.Build();

    // Middleware setup
    app.UseParalax();

    app.Run();
}

Components

Paralax.Auth

The Paralax.Auth module provides authentication and authorization mechanisms, including JWT-based authentication and OAuth2 integrations.

Paralax.CQRS

This module implements the CQRS (Command-Query Responsibility Segregation) pattern, allowing for scalable, event-driven microservices. It provides:

  • Commands: Handling write operations.
  • Queries: Handling read operations.
  • Events: Implementing event sourcing.

Paralax.MessageBrokers

Supports popular messaging systems like RabbitMQ and Kafka. It enables asynchronous communication between microservices and ensures reliable delivery of messages.

Example:

services.AddParalaxMessageBrokerRabbitMQ(options =>
{
    options.HostName = "rabbitmq.example.com";
});

Paralax.HTTP

Provides a robust HTTP client and server integration, supporting binary serialization of payloads for performance-critical services.

Paralax.WebAPI

A framework built on top of ASP.NET Core Web API, optimized for building APIs with minimal overhead. It integrates binary serialization for efficient communication and supports Swagger for API documentation.

Paralax.Logging

Out-of-the-box logging integration with support for multiple sinks (e.g., Console, Elasticsearch, etc.). It uses best-in-class logging libraries to ensure visibility into your microservices.

Paralax.Tracing

Integrated distributed tracing with OpenTelemetry and Jaeger for monitoring service calls and diagnosing bottlenecks in complex microservice architectures.


Contributing

We welcome contributions from the open-source community! To contribute, please refer to the Contributing Guide for more details on how to get started.

Reporting Issues

If you encounter bugs or issues while using Paralax, please report them through the GitHub Issues page.


License

The Paralax Framework is licensed under the Apache-2.0 License. See the LICENSE file for details.


Credits

The Paralax Framework is maintained by ITSharpPro. We appreciate contributions from developers around the world who help improve the framework for the global development community.

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Paralax.Docs.Scalar:

Package Downloads
Paralax.WebApi.Scalar

Paralax.WebApi.Scalar - Integration of Scalar documentation for Web APIs in the Paralax framework

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.436 54 12/15/2024
1.0.434 48 12/15/2024
1.0.432 48 12/15/2024
1.0.430 45 12/15/2024
1.0.428 46 12/15/2024
1.0.424 47 12/14/2024
1.0.420 62 11/23/2024
1.0.415 61 11/9/2024
1.0.410 62 11/9/2024
1.0.406 56 10/30/2024
1.0.404 58 10/30/2024
1.0.401 93 10/18/2024
1.0.396 60 10/18/2024
1.0.388 56 10/18/2024
1.0.384 62 10/18/2024
1.0.380 54 10/17/2024
1.0.376 53 10/17/2024
1.0.372 50 10/17/2024
1.0.368 60 10/17/2024
1.0.364 58 10/17/2024
1.0.356 67 10/3/2024
1.0.354 62 10/3/2024
1.0.352 62 10/3/2024
1.0.350 60 10/3/2024
1.0.348 63 10/3/2024
1.0.346 72 10/3/2024
1.0.344 65 10/3/2024
1.0.343 69 10/1/2024
1.0.342 69 9/30/2024
1.0.339 60 9/30/2024
1.0.338 66 9/30/2024
1.0.335 62 9/30/2024
1.0.332 56 9/30/2024
1.0.331 54 9/30/2024
1.0.328 59 9/30/2024
1.0.325 48 9/30/2024
1.0.322 62 9/30/2024
1.0.319 63 9/30/2024
1.0.305 64 9/29/2024
1.0.291 66 9/29/2024
1.0.268 58 9/29/2024
1.0.258 74 9/28/2024
1.0.256 54 9/28/2024
1.0.254 54 9/28/2024
1.0.217 62 9/28/2024
1.0.214 56 9/28/2024
1.0.211 57 9/28/2024
1.0.208 57 9/28/2024
1.0.205 62 9/28/2024
1.0.202 59 9/28/2024
1.0.199 57 9/27/2024
1.0.196 54 9/27/2024
1.0.193 57 9/27/2024
1.0.190 57 9/27/2024
1.0.187 60 9/27/2024
1.0.184 56 9/27/2024
1.0.181 54 9/27/2024
1.0.178 53 9/27/2024
1.0.175 59 9/26/2024
1.0.172 60 9/26/2024
1.0.169 62 9/26/2024
1.0.166 67 9/24/2024
1.0.159 67 9/23/2024
1.0.155 62 9/23/2024
1.0.152 60 9/23/2024
1.0.148 67 9/23/2024
1.0.145 66 9/23/2024
1.0.140 198 9/22/2024
1.0.137 61 9/22/2024
1.0.131 67 9/22/2024

Initial release of the Paralax.Docs.Scalar library for integrating Scalar-based documentation in microservices architecture.