Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
#44 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
冷清
技术栈
php
领域
api, backend

调研方向

首先检查现有的 Core CRUD API 端点,以及它们在响应、错误、授权和分页方面的约定。该 issue 涵盖 addon 管理、缓存和系统操作,以及 YForm CRUD,因此请确定相关的入口点,并将 MVP 拆分为针对性实现,为每个端点组制定明确的完成标准和测试。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
PHP
星标
20
派生
0
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

FriendsOfREDAXO/api 的其他 Issue

查看 FriendsOfREDAXO/api 的全部 Issue

相似的 Issue

更多 PHP Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。