# shokirjonmk/yii2-starter-swagger architecture

> Architecture diagram of the GitHub repository shokirjonmk/yii2-starter-swagger, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shokirjonmk/yii2-starter-swagger
- Repository: https://github.com/shokirjonmk/yii2-starter-swagger

## Overview

Yii2 Starter Kit is a developer-oriented advanced-site template with public web, administration, and REST API surfaces. Visitors browse content or manage accounts; administrators maintain users and site features; API clients use versioned endpoints for business data. Shared models and search/filter abstractions support these surfaces. The README documents broader capabilities such as RBAC, translations, queues, file storage, and monitoring; some of those implementation links are not visible in the sampled source, so they are represented as documented or unverified relationships rather than inferred call chains.

Main entry points: [`api/modules/v1/controllers/AbstractController.php`](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/AbstractController.php) (API Controller Base), [`frontend/modules/user/controllers/SignInController.php`](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/frontend/modules/user/controllers/SignInController.php) (Account Access), [`backend/controllers/UserController.php`](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/controllers/UserController.php) (User Administration), [`backend/modules/system/controllers/KeyStorageController.php`](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/modules/system/controllers/KeyStorageController.php) (Settings Editor)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Public Web"]
  node_frontend_site["Public Site<br/>[SiteController.php]"]
  node_frontend_content["Article Pages"]
  node_frontend_auth["Account Access"]
  node_frontend_user_forms["Account Forms<br/>[SignupForm.php]"]
end

subgraph group_admin["Administration"]
  node_admin_users["User Administration<br/>[UserController.php]"]
  node_admin_content["Content Management"]
  node_admin_rbac["RBAC Management"]
  node_admin_files["File Management"]
  node_admin_settings["Settings Editor"]
  node_admin_market["Marketplace Admin"]
end

subgraph group_api["REST API"]
  node_api_base["API Controller Base"]
  node_api_orders["Order Endpoints"]
  node_api_products["Product Endpoints"]
  node_api_suppliers["Supplier Endpoints"]
  node_api_receiving["Receiving Goods"]
  node_api_auth["API Authentication<br/>[AuthController.php]"]
end

subgraph group_domain["Domain Services"]
  node_user_model["User Model<br/>[User.php]"]
  node_token_model["User Tokens<br/>[UserToken.php]"]
  node_supplier_model["Supplier Model<br/>[Supplier.php]"]
  node_buyer_model["Supplier Buyer Model<br/>[SupplierBuyer.php]"]
  node_file_model[("File Metadata")]
  node_key_item[("Settings Records<br/>[KeyStorageItem.php]")]
end

subgraph group_shared["Shared Platform"]
  node_filter_base["Search Filter Base<br/>[BaseFilter.php]"]
  node_filter_defaults["Default Search<br/>[DefaultFilter.php]"]
  node_data_provider["Data Provider"]
  node_deleted_model["Soft Delete Support<br/>[DeletedModel.php]"]
  node_base_controller["Shared Controller<br/>[BaseController.php]"]
  node_key_storage["Key Storage<br/>[KeyStorage.php]"]
end

node_visitor(("Site Visitor"))
node_administrator(("Administrator"))
node_api_client(("API Client"))

node_visitor -->|"browses"| node_frontend_site
node_visitor -.->|"reads content"| node_frontend_content
node_visitor -->|"signs in"| node_frontend_auth
node_frontend_auth -->|"uses forms"| node_frontend_user_forms
node_frontend_auth -->|"manages accounts"| node_user_model
node_frontend_auth -->|"uses tokens"| node_token_model
node_administrator -->|"administers users"| node_admin_users
node_administrator -->|"manages content"| node_admin_content
node_administrator -->|"manages roles"| node_admin_rbac
node_administrator -->|"manages files"| node_admin_files
node_administrator -->|"edits settings"| node_admin_settings
node_administrator -.->|"manages marketplace"| node_admin_market
node_admin_users -->|"loads and saves"| node_user_model
node_admin_users -->|"creates tokens"| node_token_model
node_admin_files -->|"queries metadata"| node_file_model
node_admin_settings -->|"loads and saves"| node_key_item
node_admin_settings -.->|"edits settings"| node_key_storage
node_api_client -->|"sends requests"| node_api_base
node_api_base -.->|"routes requests"| node_api_orders
node_api_base -.->|"routes requests"| node_api_products
node_api_base -.->|"routes requests"| node_api_suppliers
node_api_base -->|"routes requests"| node_api_receiving
node_api_client -.->|"authenticates"| node_api_auth
node_api_receiving -->|"queries suppliers"| node_supplier_model
node_api_receiving -->|"filters results"| node_filter_base
node_filter_base -->|"uses defaults"| node_filter_defaults
node_filter_base -->|"builds provider"| node_data_provider
node_admin_files -->|"searches metadata"| node_file_model
node_admin_settings -->|"searches records"| node_key_item
node_admin_users -.->|"extends controller"| node_base_controller
node_api_receiving -->|"supports deletion"| node_deleted_model
node_supplier_model -.->|"related domain data"| node_buyer_model

click node_frontend_site "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/frontend/controllers/SiteController.php"
click node_frontend_content "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/frontend/controllers/ArticleController.php"
click node_frontend_auth "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/frontend/modules/user/controllers/SignInController.php"
click node_frontend_user_forms "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/frontend/modules/user/models/SignupForm.php"
click node_admin_users "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/controllers/UserController.php"
click node_admin_content "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/modules/content/controllers/ArticleController.php"
click node_admin_rbac "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/modules/rbac/controllers/RbacAuthAssignmentController.php"
click node_admin_files "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/modules/file/controllers/StorageController.php"
click node_admin_settings "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/modules/system/controllers/KeyStorageController.php"
click node_admin_market "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/modules/marketplace/controllers/SupplierBuyerController.php"
click node_api_base "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/AbstractController.php"
click node_api_orders "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/OrderController.php"
click node_api_products "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/ProductController.php"
click node_api_suppliers "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/PurveyorController.php"
click node_api_receiving "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/ReceivingGoodsController.php"
click node_api_auth "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/AuthController.php"
click node_user_model "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/models/User.php"
click node_token_model "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/models/UserToken.php"
click node_supplier_model "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/models/Supplier.php"
click node_buyer_model "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/models/SupplierBuyer.php"
click node_file_model "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/models/FileStorageItem.php"
click node_filter_base "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/base/BaseFilter.php"
click node_filter_defaults "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/base/search/DefaultFilter.php"
click node_data_provider "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/base/search/DefaultDataProvider.php"
click node_deleted_model "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/components/DeletedModel.php"
click node_base_controller "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/controllers/BaseController.php"
click node_key_storage "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/components/keyStorage/KeyStorage.php"
click node_key_item "https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/models/KeyStorageItem.php"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_frontend_site,node_frontend_content,node_frontend_auth,node_frontend_user_forms,node_api_client toneBlue
class node_admin_users,node_admin_content,node_admin_rbac,node_admin_files,node_admin_settings,node_admin_market toneAmber
class node_api_base,node_api_orders,node_api_products,node_api_suppliers,node_api_receiving,node_api_auth toneMint
class node_user_model,node_token_model,node_supplier_model,node_buyer_model,node_file_model,node_key_item toneRose
class node_filter_base,node_filter_defaults,node_data_provider,node_deleted_model,node_base_controller,node_key_storage,node_visitor,node_administrator toneIndigo
```

## Components

### Public Web

- [Public Site](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/frontend/controllers/SiteController.php): `frontend/controllers/SiteController.php`
- [Article Pages](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/frontend/controllers/ArticleController.php): `frontend/controllers/ArticleController.php`
- [Account Access](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/frontend/modules/user/controllers/SignInController.php): `frontend/modules/user/controllers/SignInController.php`
- [Account Forms](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/frontend/modules/user/models/SignupForm.php): `frontend/modules/user/models/SignupForm.php`

### Administration

- [User Administration](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/controllers/UserController.php): `backend/controllers/UserController.php`
- [Content Management](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/modules/content/controllers/ArticleController.php): `backend/modules/content/controllers/ArticleController.php`
- [RBAC Management](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/modules/rbac/controllers/RbacAuthAssignmentController.php): `backend/modules/rbac/controllers/RbacAuthAssignmentController.php`
- [File Management](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/modules/file/controllers/StorageController.php): `backend/modules/file/controllers/StorageController.php`
- [Settings Editor](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/modules/system/controllers/KeyStorageController.php): `backend/modules/system/controllers/KeyStorageController.php`
- [Marketplace Admin](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/backend/modules/marketplace/controllers/SupplierBuyerController.php): `backend/modules/marketplace/controllers/SupplierBuyerController.php`

### REST API

- [API Controller Base](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/AbstractController.php): `api/modules/v1/controllers/AbstractController.php`
- [Order Endpoints](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/OrderController.php): `api/modules/v1/controllers/OrderController.php`
- [Product Endpoints](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/ProductController.php): `api/modules/v1/controllers/ProductController.php`
- [Supplier Endpoints](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/PurveyorController.php): `api/modules/v1/controllers/PurveyorController.php`
- [Receiving Goods](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/ReceivingGoodsController.php): `api/modules/v1/controllers/ReceivingGoodsController.php`
- [API Authentication](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/api/modules/v1/controllers/AuthController.php): `api/modules/v1/controllers/AuthController.php`

### Domain Services

- [User Model](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/models/User.php): `common/models/User.php`
- [User Tokens](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/models/UserToken.php): `common/models/UserToken.php`
- [Supplier Model](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/models/Supplier.php): `common/models/Supplier.php`
- [Supplier Buyer Model](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/models/SupplierBuyer.php): `common/models/SupplierBuyer.php`
- [File Metadata](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/models/FileStorageItem.php): `common/models/FileStorageItem.php`
- [Settings Records](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/models/KeyStorageItem.php): `common/models/KeyStorageItem.php`

### Shared Platform

- [Search Filter Base](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/base/BaseFilter.php): `common/base/BaseFilter.php`
- [Default Search](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/base/search/DefaultFilter.php): `common/base/search/DefaultFilter.php`
- [Data Provider](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/base/search/DefaultDataProvider.php): `common/base/search/DefaultDataProvider.php`
- [Soft Delete Support](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/components/DeletedModel.php): `common/components/DeletedModel.php`
- [Shared Controller](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/controllers/BaseController.php): `common/controllers/BaseController.php`
- [Key Storage](https://github.com/shokirjonmk/yii2-starter-swagger/blob/main/common/components/keyStorage/KeyStorage.php): `common/components/keyStorage/KeyStorage.php`

### Other components

- **Site Visitor**
- **Administrator**
- **API Client**

## Connections

- Site Visitor → Public Site: browses
- Site Visitor → Article Pages: reads content
- Site Visitor → Account Access: signs in
- Account Access → Account Forms: uses forms (evidence: `frontend/modules/user/controllers/SignInController.php`)
- Account Access → User Model: manages accounts (evidence: `frontend/modules/user/controllers/SignInController.php`)
- Account Access → User Tokens: uses tokens (evidence: `frontend/modules/user/controllers/SignInController.php`)
- Administrator → User Administration: administers users
- Administrator → Content Management: manages content
- Administrator → RBAC Management: manages roles
- Administrator → File Management: manages files
- Administrator → Settings Editor: edits settings
- Administrator → Marketplace Admin: manages marketplace
- User Administration → User Model: loads and saves (evidence: `backend/controllers/UserController.php`)
- User Administration → User Tokens: creates tokens (evidence: `backend/controllers/UserController.php`)
- File Management → File Metadata: queries metadata (evidence: `backend/modules/file/controllers/StorageController.php`)
- Settings Editor → Settings Records: loads and saves (evidence: `backend/modules/system/controllers/KeyStorageController.php`)
- Settings Editor → Key Storage: edits settings
- API Client → API Controller Base: sends requests
- API Controller Base → Order Endpoints: routes requests
- API Controller Base → Product Endpoints: routes requests
- API Controller Base → Supplier Endpoints: routes requests
- API Controller Base → Receiving Goods: routes requests (evidence: `api/modules/v1/controllers/ReceivingGoodsController.php`)
- API Client → API Authentication: authenticates
- Receiving Goods → Supplier Model: queries suppliers (evidence: `api/modules/v1/controllers/ReceivingGoodsController.php`)
- Receiving Goods → Search Filter Base: filters results (evidence: `api/modules/v1/controllers/ReceivingGoodsController.php`)
- Search Filter Base → Default Search: uses defaults (evidence: `common/base/BaseFilter.php`)
- Search Filter Base → Data Provider: builds provider (evidence: `common/base/BaseFilter.php`)
- File Management → File Metadata: searches metadata (evidence: `backend/modules/file/controllers/StorageController.php`)
- Settings Editor → Settings Records: searches records (evidence: `backend/modules/system/controllers/KeyStorageController.php`)
- User Administration → Shared Controller: extends controller (evidence: `backend/controllers/UserController.php`)
- Receiving Goods → Soft Delete Support: supports deletion (evidence: `api/modules/v1/controllers/ReceivingGoodsController.php`)
- Supplier Model → Supplier Buyer Model: related domain data
