this

this-rs Documentation

Framework for building complex multi-entity REST and GraphQL APIs with many relationships.

🎯 Is This Framework Right for You?

this-rs is designed for APIs with 5+ entities and complex relationships.

✅ Use this-rs if you have:

• Many entities (5+) with CRUD operations
• Complex relationships (many-to-many, bidirectional)
• Need for both REST and GraphQL
• Microservices architecture

⚠️ Consider alternatives if you have:

• Simple CRUD (< 5 entities)
• No/few relationships
• Learning Rust/Axum (start with Axum directly)

See the main README for detailed comparison.

---

📚 Navigation Guide

🚀 Quick Start

• Getting Started - First steps with this-rs
• Quick Start - Quick start guide

✅ Validation and Filtering

• Validation and Filtering - Automatic data validation and filtering
• Pagination and Filtering - 🆕 Generic pagination and query filtering

🔗 Link Management

• Enriched Links - Complete entities in links (auto-enrichment)
• Semantic URLs - 🆕 Coherent and intuitive URLs for links
• Link Authorization - Permissions at link level
• Link Metadata - Metadata and link updates
• Multi-Level Navigation - Multi-level navigation

📡 API Exposure

• GraphQL - 🆕 Dynamic GraphQL API with automatic schema generation
• GraphQL Implementation - Technical details of GraphQL exposure

🔄 Comparison & Alternatives

• Alternatives - 🆕 Honest comparison with other solutions (Axum, async-graphql, SeaORM, etc.)

🏗️ Architecture

• Architecture - Architecture overview
• ServerBuilder Implementation - Auto-generated routes
• Routing Explanation - Routing explanations
• GraphQL Implementation - GraphQL exposure architecture

📝 Change History

• Latest Changes - 🆕 Latest major changes (Pagination & Validation)
• Semantic URLs - Coherent URLs for link operations
• Enriched Links Implementation - Enrichment implementation
• Auto-Routing Success - Auto-routing implementation
• Module Restructuring - Module restructuring
• Store Simplification - Store simplification
• Entity Folders Structure - Folder organization

🎯 By Use Case

I want to get started with this-rs

→ Getting Started

I want to understand the architecture

→ Architecture

I want to create a microservice

→ Examples README

I want to understand auto-routing

→ ServerBuilder Implementation

I want to understand enriched links

→ Enriched Links

I want to manage link permissions

→ Link Authorization

I want to use GraphQL

→ GraphQL Guide

I want to compare this-rs with alternatives

→ Alternatives Comparison

📂 Documentation Structure

docs/
├── README.md                    # This file (index)
├── architecture/                # Technical documentation
│   ├── ARCHITECTURE.md
│   ├── SERVER_BUILDER_IMPLEMENTATION.md
│   ├── ROUTING_EXPLANATION.md
│   └── GRAPHQL_IMPLEMENTATION.md  # 🆕 GraphQL technical details
├── guides/                      # User guides
│   ├── GETTING_STARTED.md
│   ├── QUICK_START.md
│   ├── VALIDATION_AND_FILTERING.md  # Data validation and filtering
│   ├── PAGINATION_AND_FILTERING.md  # 🆕 Pagination and query filtering
│   ├── GRAPHQL.md              # 🆕 GraphQL API guide
│   ├── ENRICHED_LINKS.md       # Auto-enrichment of links
│   ├── LINK_AUTHORIZATION.md
│   ├── LINK_METADATA.md
│   └── MULTI_LEVEL_NAVIGATION.md
└── changes/                     # Change history
    ├── SEMANTIC_URLS.md        # 🆕 Semantic URLs for links
    ├── ENRICHED_LINKS_IMPLEMENTATION.md
    ├── AUTO_ROUTING_SUCCESS.md
    ├── LATEST_CHANGES.md
    ├── MODULE_RESTRUCTURING.md
    ├── STORE_SIMPLIFICATION.md
    └── ENTITY_FOLDERS_STRUCTURE.md

🔗 Useful Links

• Main README
• Examples
• Source Code

This site is open source. Improve this page.