feat: add read-only Sites API
Add GET /api/sites endpoint for listing sites with optional name filter,
and GET /api/sites/{site} for showing individual sites. Includes API
resource, controller, routes registration, and comprehensive tests.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Sonnet 5
parent
cee5b1976b
commit
20c33f1c23
@@ -0,0 +1,27 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Http\Controllers\Api;
|
||||||
|
|
||||||
|
use App\Http\Controllers\Controller;
|
||||||
|
use App\Http\Resources\SiteResource;
|
||||||
|
use App\Models\Site;
|
||||||
|
use Illuminate\Http\Request;
|
||||||
|
|
||||||
|
class SiteController extends Controller
|
||||||
|
{
|
||||||
|
public function index(Request $request)
|
||||||
|
{
|
||||||
|
$query = Site::query();
|
||||||
|
|
||||||
|
if ($request->filled('name')) {
|
||||||
|
$query->where('name', 'like', '%' . $request->string('name') . '%');
|
||||||
|
}
|
||||||
|
|
||||||
|
return SiteResource::collection($query->orderBy('name')->get());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function show(Site $site)
|
||||||
|
{
|
||||||
|
return new SiteResource($site);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Http\Resources;
|
||||||
|
|
||||||
|
use Illuminate\Http\Request;
|
||||||
|
use Illuminate\Http\Resources\Json\JsonResource;
|
||||||
|
|
||||||
|
class SiteResource extends JsonResource
|
||||||
|
{
|
||||||
|
public function toArray(Request $request): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'id' => $this->id,
|
||||||
|
'name' => $this->name,
|
||||||
|
'url' => $this->url,
|
||||||
|
'description' => $this->description,
|
||||||
|
'created_at' => $this->created_at,
|
||||||
|
'updated_at' => $this->updated_at,
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -8,6 +8,7 @@ use Illuminate\Http\Request;
|
|||||||
return Application::configure(basePath: dirname(__DIR__))
|
return Application::configure(basePath: dirname(__DIR__))
|
||||||
->withRouting(
|
->withRouting(
|
||||||
web: __DIR__.'/../routes/web.php',
|
web: __DIR__.'/../routes/web.php',
|
||||||
|
api: __DIR__.'/../routes/api.php',
|
||||||
commands: __DIR__.'/../routes/console.php',
|
commands: __DIR__.'/../routes/console.php',
|
||||||
health: '/up',
|
health: '/up',
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -0,0 +1,7 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use App\Http\Controllers\Api\SiteController;
|
||||||
|
use Illuminate\Support\Facades\Route;
|
||||||
|
|
||||||
|
Route::get('/sites', [SiteController::class, 'index']);
|
||||||
|
Route::get('/sites/{site}', [SiteController::class, 'show']);
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use App\Models\Site;
|
||||||
|
|
||||||
|
test('it lists all sites', function () {
|
||||||
|
Site::factory()->count(3)->create();
|
||||||
|
|
||||||
|
$response = $this->getJson('/api/sites');
|
||||||
|
|
||||||
|
$response->assertOk()->assertJsonCount(3, 'data');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('it filters sites by partial name match', function () {
|
||||||
|
Site::factory()->create(['name' => 'My Awesome Blog']);
|
||||||
|
Site::factory()->create(['name' => 'Other Site']);
|
||||||
|
|
||||||
|
$response = $this->getJson('/api/sites?name=Awesome');
|
||||||
|
|
||||||
|
$response->assertOk()
|
||||||
|
->assertJsonCount(1, 'data')
|
||||||
|
->assertJsonPath('data.0.name', 'My Awesome Blog');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('it shows a single site', function () {
|
||||||
|
$site = Site::factory()->create(['name' => 'Solo Site']);
|
||||||
|
|
||||||
|
$response = $this->getJson("/api/sites/{$site->id}");
|
||||||
|
|
||||||
|
$response->assertOk()->assertJsonPath('data.name', 'Solo Site');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('it returns 404 for a missing site', function () {
|
||||||
|
$this->getJson('/api/sites/999')->assertNotFound();
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user