Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Konsolidierung fehlender Endpunkte für Remote-Backend-Frontend (notwendig vs. wünschenswert)

Đang mở
  • Có gì không ổn?
#44 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Ít trao đổi
Công nghệ
php
Lĩnh vực
api, backend

Hướng nghiên cứu

Bắt đầu bằng cách kiểm tra các endpoint Core CRUD API hiện có cùng với các quy ước về response, error, authorization và paging của chúng. Issue này bao gồm việc quản lý addon, các thao tác cache và system, cũng như YForm CRUD, vì vậy hãy xác định các entry point liên quan và chia MVP thành các triển khai tập trung, với tiêu chí hoàn thành rõ ràng và các bài kiểm thử cho từng nhóm endpoint.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Kontext

Bei der Entwicklung eines Remote-Backend-Frontends für REDAXO (Control-Plane über API) ist aufgefallen, dass mehrere zentrale Betriebs- und Daten-Endpunkte fehlen.

Im aktuellen Stand sind Core-CRUD-Endpunkte (Structure/Media/Templates/Modules/Users/Clangs/Metainfo) vorhanden, aber für den produktiven Remote-Betrieb fehlen wichtige API-Bausteine.

Notwendig (MVP)

1) Addon-Management
  • GET /addons — Addon-Liste inkl. installed/active Status
  • GET /addons/{id} — Addon-Details (Version, Requirements, Dependencies)
  • PATCH /addons/{id}/status — aktivieren/deaktivieren
2) Addon Lifecycle
  • POST /addons/{id}/install
  • POST /addons/{id}/uninstall
  • POST /addons/{id}/activate
  • POST /addons/{id}/deactivate
  • POST /addons/{id}/upgrade
3) Cache-Management
  • GET /cache/status — Größe/Status/Last-Rebuild
  • DELETE /cache/all
  • DELETE /cache/{type} — z. B. db, templates, packages
4) System-Information / Betrieb
  • GET /system/info — PHP/REDAXO/Basisinfos
  • GET /system/disk — Disk Space
  • GET /system/database — DB-Größe/Tabellenanzahl
  • GET /system/health — Basis-Healthcheck
5) YForm API (für datengetriebene Remote-Backends essenziell)
  • GET /yform/tables
  • GET /yform/tables/{table}
  • GET /yform/tables/{table}/fields
  • GET /yform/tables/{table}/records
  • GET /yform/tables/{table}/records/{id}
  • POST /yform/tables/{table}/records
  • PATCH /yform/tables/{table}/records/{id}
  • DELETE /yform/tables/{table}/records/{id}

Wünschenswert (Ausbau)

Addon Ops / UX
  • GET /addons/{id}/health — Readiness/Requirement-Check
  • POST /addons/{id}/setup/check — Preflight vor Install/Aktivierung
  • GET /addons/{id}/logs — letzte Install/Update-Logs
YForm Komfort-Endpunkte
  • GET /yform/tables/{table}/options/{field} — Select/Choice-Optionen
  • GET /yform/lookups/{table} — Lightweight-Lookups (id + label)
  • POST /yform/tables/{table}/validate — Payload validieren ohne Persistenz
Optional für Betrieb
  • Erweiterter Healthcheck mit Teilstatus (db, filesystem, cache, addons)
  • Einheitliche Betriebs-Metriken für Dashboard-Kacheln

Anforderungen (für alle neuen Endpunkte)

  • Einheitliches Response-Schema (wie bestehende API)
  • Saubere Fehlercodes (400, 403, 404, 409, 422, 500)
  • Klare Admin-Berechtigung für mutierende Operationen (POST/PATCH/DELETE)
  • Konsistentes Paging/Sorting/Filtering bei Listen

Warum Priorität

Diese Lücken sind im praktischen Aufbau eines Remote-Backends direkt aufgetreten.
Ohne diese Endpunkte bleibt das Dashboard zwar für Basis-CRUD nutzbar, aber nicht als vollständige Control-Plane für Betrieb, Wartung, Addon-Lifecycle und YForm-Datenmanagement.

Ngôn ngữ chính
PHP
Star
20
Fork
0
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của FriendsOfREDAXO/api

Tất cả issue của FriendsOfREDAXO/api

Issue tương tự

Thêm issue về PHP

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.