**Enhance API functionality and localizations**

- 🌐 Added API documentation annotations for multiple controllers (Meetups, Cities, Countries, Courses, Highscores, Venues), improving public and developer-facing endpoint clarity.
-  Integrated and configured the `dedoc/scramble` package for automated OpenAPI documentation generation.
- 🔒 Excluded internal routes and actions from API documentation using `ExcludeRouteFromDocs` attributes.
- 🌍 Added new localization keys for API Token features across multiple languages (`lv`, `es`, etc.).
- 🛠️ Introduced `Group`, `Response`, and `QueryParameter` attributes for better request descriptions and structured documentation.
- 🚀 Enhanced functionality for listing operations in controllers with filters and query parameters like `search` and `selected`.
This commit is contained in:
HolgerHatGarKeineNode
2026-06-08 00:09:59 +02:00
parent 5a325b1b28
commit 351dd87fa9
29 changed files with 1178 additions and 421 deletions
+26 -28
View File
@@ -4,16 +4,31 @@ namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Models\Meetup;
use Dedoc\Scramble\Attributes\ExcludeRouteFromDocs;
use Dedoc\Scramble\Attributes\Group;
use Dedoc\Scramble\Attributes\QueryParameter;
use Dedoc\Scramble\Attributes\Response;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
#[Group(name: 'Meetups', weight: 3)]
class MeetupController extends Controller
{
#[ExcludeRouteFromDocs]
public function ical()
{
abort(404);
}
/**
* Eigene Meetups auflisten
*
* Liefert die Meetups des angemeldeten Nutzers (id, name, inklusive Stadt/Land und Profilbild),
* alphabetisch sortiert. Erfordert eine authentifizierte Sitzung (sonst 401).
*/
#[QueryParameter(name: 'search', description: 'Teilstring-Suche im Meetup- oder Stadtnamen.', required: false, type: 'string')]
#[QueryParameter(name: 'selected', description: 'Lädt gezielt die angegebenen Meetup-IDs.', required: false, type: 'array')]
#[Response(status: 401, description: 'Nicht authentifiziert.')]
public function index(Request $request)
{
$user = $request->user();
@@ -30,16 +45,15 @@ class MeetupController extends Controller
->orderBy('name')
->when(
$request->search,
fn(Builder $query)
=> $query
fn (Builder $query) => $query
->where('name', 'like', "%{$request->search}%")
->orWhereHas('city',
fn(Builder $query) => $query->where('cities.name', 'ilike', "%{$request->search}%")),
fn (Builder $query) => $query->where('cities.name', 'ilike', "%{$request->search}%")),
)
->when(
$request->exists('selected'),
fn(Builder $query) => $query->whereIn('id', $request->input('selected', [])),
fn(Builder $query) => $query->limit(10),
fn (Builder $query) => $query->whereIn('id', $request->input('selected', [])),
fn (Builder $query) => $query->limit(10),
)
->get()
->map(function (Meetup $meetup) {
@@ -49,42 +63,26 @@ class MeetupController extends Controller
});
}
/**
* Store a newly created resource in storage.
*
* @return \Illuminate\Http\Response
*/
#[ExcludeRouteFromDocs]
public function store(Request $request)
{
//
}
/**
* Display the specified resource.
*
* @return \Illuminate\Http\Response
*/
public function show(meetup $meetup)
#[ExcludeRouteFromDocs]
public function show(Meetup $meetup)
{
//
}
/**
* Update the specified resource in storage.
*
* @return \Illuminate\Http\Response
*/
public function update(Request $request, meetup $meetup)
#[ExcludeRouteFromDocs]
public function update(Request $request, Meetup $meetup)
{
//
}
/**
* Remove the specified resource from storage.
*
* @return \Illuminate\Http\Response
*/
public function destroy(meetup $meetup)
#[ExcludeRouteFromDocs]
public function destroy(Meetup $meetup)
{
//
}