# foticc/api-micro-simple architecture

> Architecture diagram of the GitHub repository foticc/api-micro-simple, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/foticc/api-micro-simple
- Repository: https://github.com/foticc/api-micro-simple

## Overview

##### Project type and purpose
- This is a standalone backend service written in Rust. It exposes a set of RESTful APIs for user, role, permission, department, and menu management. It uses SeaORM to map between Rust structs (“entity” layer) and a PostgreSQL database. The service is containerized with Docker.

##### File structure
- Top-level files:
- Cargo.toml / Cargo.lock – Rust package and dependency management
- Dockerfile, docker-compose.yml – container definition and multi-container orchestration
- .env – environment variables (DB URL, credentials)
- src/
- api/ – HTTP controllers (auth_api.rs, user_api.rs, role_api.rs, etc.)
- service/ – business logic layer corresponding to each API
- entity/ – SeaORM-generated entities and relations for database tables
- common/ – cross-cutting utilities (result handling, security/jwt, simple cache)
- main.rs – application entry point, router setup

##### Readme insights
- The README shows how to generate entities from the live database and how to spin up the app via Docker Compose. No separate frontend here—this is purely a backend service.

##### Elements
- Clear labels for each component (e.g., “Auth API”, “User Service”, “SeaORM Entities”)
– Blue rectangles for layers (API, Service, Data)
– Docker whale for containerization

## Diagram (Mermaid)

```mermaid
flowchart TB
    Client["Client (HTTP)"]:::external

    subgraph "Docker Compose"
        direction TB
        Dockerfile["Dockerfile"]:::config
        ComposeFile["docker-compose.yml"]:::config
        EnvFile[".env"]:::config
        CargoToml["Cargo.toml"]:::config
        CargoLock["Cargo.lock"]:::config

        subgraph "Rust Backend Service"
            direction TB
            subgraph "REST API Layer"
                direction TB
                AuthAPI["auth_api.rs"]:::api
                UserAPI["user_api.rs"]:::api
                RoleAPI["role_api.rs"]:::api
                PermissionAPI["permission_api.rs"]:::api
                DepartmentAPI["department_api.rs"]:::api
                MenuAPI["menu_api.rs"]:::api
                ModAPI["mod.rs"]:::api
            end

            subgraph "Service Layer"
                direction TB
                AuthService["auth.rs"]:::service
                UserService["user_service.rs"]:::service
                RoleService["role_service.rs"]:::service
                PermissionService["permission_service.rs"]:::service
                DepartmentService["department_service.rs"]:::service
                MenuService["menu_service.rs"]:::service
                ModService["mod.rs"]:::service
            end

            subgraph "Data Access Layer"
                direction TB
                UserEntity["user.rs"]:::data
                RoleEntity["role.rs"]:::data
                SysUserRole["sys_user_role.rs"]:::data
                SysRolePerm["sys_role_perm.rs"]:::data
                DepartmentEntity["department.rs"]:::data
                MenuEntity["menu.rs"]:::data
                Prelude["prelude.rs"]:::data
                ModEntity["mod.rs"]:::data
            end

            subgraph "Common Utilities"
                direction TB
                ResultUtil["result.rs"]:::util
                SecurityUtil["security.rs"]:::util
                CacheUtil["simple_cache.rs"]:::util
                ModCommon["mod.rs"]:::util
            end

            Main["main.rs"]:::main
        end

        DB[(PostgreSQL)]:::db
    end

    Client --> AuthAPI
    Client --> UserAPI
    Client --> RoleAPI
    Client --> PermissionAPI
    Client --> DepartmentAPI
    Client --> MenuAPI

    AuthAPI --> AuthService
    UserAPI --> UserService
    RoleAPI --> RoleService
    PermissionAPI --> PermissionService
    DepartmentAPI --> DepartmentService
    MenuAPI --> MenuService

    AuthService --> UserEntity
    UserService --> UserEntity
    RoleService --> RoleEntity
    PermissionService --> SysRolePerm
    DepartmentService --> DepartmentEntity
    MenuService --> MenuEntity

    ModEntity --> DB

    SecurityUtil --> AuthAPI
    CacheUtil --> AuthService

    Main --> AuthAPI
    Main --> AuthService
    Main --> UserEntity

    click AuthAPI "https://github.com/foticc/api-micro-simple/blob/main/src/api/auth_api.rs"
    click UserAPI "https://github.com/foticc/api-micro-simple/blob/main/src/api/user_api.rs"
    click RoleAPI "https://github.com/foticc/api-micro-simple/blob/main/src/api/role_api.rs"
    click PermissionAPI "https://github.com/foticc/api-micro-simple/blob/main/src/api/permission_api.rs"
    click DepartmentAPI "https://github.com/foticc/api-micro-simple/blob/main/src/api/department_api.rs"
    click MenuAPI "https://github.com/foticc/api-micro-simple/blob/main/src/api/menu_api.rs"
    click ModAPI "https://github.com/foticc/api-micro-simple/blob/main/src/api/mod.rs"

    click AuthService "https://github.com/foticc/api-micro-simple/blob/main/src/service/auth.rs"
    click UserService "https://github.com/foticc/api-micro-simple/blob/main/src/service/user_service.rs"
    click RoleService "https://github.com/foticc/api-micro-simple/blob/main/src/service/role_service.rs"
    click PermissionService "https://github.com/foticc/api-micro-simple/blob/main/src/service/permission_service.rs"
    click DepartmentService "https://github.com/foticc/api-micro-simple/blob/main/src/service/department_service.rs"
    click MenuService "https://github.com/foticc/api-micro-simple/blob/main/src/service/menu_service.rs"
    click ModService "https://github.com/foticc/api-micro-simple/blob/main/src/service/mod.rs"

    click UserEntity "https://github.com/foticc/api-micro-simple/blob/main/src/entity/user.rs"
    click RoleEntity "https://github.com/foticc/api-micro-simple/blob/main/src/entity/role.rs"
    click SysUserRole "https://github.com/foticc/api-micro-simple/blob/main/src/entity/sys_user_role.rs"
    click SysRolePerm "https://github.com/foticc/api-micro-simple/blob/main/src/entity/sys_role_perm.rs"
    click DepartmentEntity "https://github.com/foticc/api-micro-simple/blob/main/src/entity/department.rs"
    click MenuEntity "https://github.com/foticc/api-micro-simple/blob/main/src/entity/menu.rs"
    click Prelude "https://github.com/foticc/api-micro-simple/blob/main/src/entity/prelude.rs"
    click ModEntity "https://github.com/foticc/api-micro-simple/blob/main/src/entity/mod.rs"

    click ResultUtil "https://github.com/foticc/api-micro-simple/blob/main/src/common/result.rs"
    click SecurityUtil "https://github.com/foticc/api-micro-simple/blob/main/src/common/security.rs"
    click CacheUtil "https://github.com/foticc/api-micro-simple/blob/main/src/common/simple_cache.rs"
    click ModCommon "https://github.com/foticc/api-micro-simple/blob/main/src/common/mod.rs"

    click Main "https://github.com/foticc/api-micro-simple/blob/main/src/main.rs"
    click Dockerfile "https://github.com/foticc/api-micro-simple/tree/main/Dockerfile"
    click ComposeFile "https://github.com/foticc/api-micro-simple/blob/main/docker-compose.yml"
    click EnvFile "https://github.com/foticc/api-micro-simple/blob/main/.env"
    click CargoToml "https://github.com/foticc/api-micro-simple/blob/main/Cargo.toml"
    click CargoLock "https://github.com/foticc/api-micro-simple/blob/main/Cargo.lock"

    classDef external fill:#CCCCFF,stroke:#333,stroke-width:1px
    classDef api fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef service fill:#87CEEB,stroke:#333,stroke-width:1px
    classDef data fill:#B0E0E6,stroke:#333,stroke-width:1px
    classDef util fill:#FFDAB9,stroke:#333,stroke-width:1px
    classDef db fill:#FFE4B5,stroke:#333,stroke-width:1px
    classDef main fill:#E6E6FA,stroke:#333,stroke-width:1px
    classDef config fill:#F0E68C,stroke:#333,stroke-width:1px
```
