**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
+18 -21
View File
@@ -4,11 +4,22 @@ namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Models\Country;
use Dedoc\Scramble\Attributes\ExcludeRouteFromDocs;
use Dedoc\Scramble\Attributes\Group;
use Dedoc\Scramble\Attributes\QueryParameter;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
#[Group(name: 'Stammdaten', weight: 5)]
class CountryController extends Controller
{
/**
* Länder auflisten und durchsuchen
*
* Öffentlicher Endpunkt; liefert id, name und code (Ländercode), alphabetisch sortiert. Ohne 'selected' wird das Ergebnis auf 10 Einträge begrenzt. Jedes Land enthält zusätzlich eine 'flag' (SVG-URL).
*/
#[QueryParameter(name: 'search', description: 'Suche in Name oder Code (Ländercode).', required: false, type: 'string')]
#[QueryParameter(name: 'selected', description: 'Lädt gezielt die angegebenen Codes oder IDs.', required: false, type: 'array')]
public function index(Request $request)
{
return Country::query()
@@ -16,19 +27,17 @@ class CountryController extends Controller
->orderBy('name')
->when(
$request->search,
fn(Builder $query)
=> $query
fn (Builder $query) => $query
->where('name', 'ilike', "%{$request->search}%")
->orWhere('code', 'ilike', "%{$request->search}%"),
)
->when(
$request->exists('selected'),
fn(Builder $query)
=> $query
fn (Builder $query) => $query
->whereIn('code', $request->input('selected', []))
->orWhereIn('id',
$request->input('selected', [])),
fn(Builder $query) => $query->limit(10),
fn (Builder $query) => $query->limit(10),
)
->get()
->map(function (Country $country) {
@@ -38,37 +47,25 @@ class CountryController 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
*/
#[ExcludeRouteFromDocs]
public function show(Country $country)
{
//
}
/**
* Update the specified resource in storage.
* @return \Illuminate\Http\Response
*/
#[ExcludeRouteFromDocs]
public function update(Request $request, Country $country)
{
//
}
/**
* Remove the specified resource from storage.
* @return \Illuminate\Http\Response
*/
#[ExcludeRouteFromDocs]
public function destroy(Country $country)
{
//