[6.x] REST API: ping and sites endpoints

config/api.php

@@ -24,6 +24,7 @@
         'assets' => false,
         'globals' => false,
         'forms' => false,
+        'sites' => false,
         'users' => false,
     ],
 

routes/api.php

@@ -8,6 +8,8 @@
 use Statamic\Http\Controllers\API\GlobalsController;
 use Statamic\Http\Controllers\API\NavigationTreeController;
 use Statamic\Http\Controllers\API\NotFoundController;
+use Statamic\Http\Controllers\API\PingController;
+use Statamic\Http\Controllers\API\SitesController;
 use Statamic\Http\Controllers\API\TaxonomyTermEntriesController;
 use Statamic\Http\Controllers\API\TaxonomyTermsController;
 use Statamic\Http\Controllers\API\UsersController;
@@ -18,11 +20,14 @@
 Route::resource('globals', GlobalsController::class)->only('index', 'show');
 Route::resource('forms', FormsController::class)->only('index', 'show');
 Route::resource('users', UsersController::class)->only('index', 'show');
+Route::resource('sites', SitesController::class)->only('index');
 
 Route::name('assets.index')->get('assets/{asset_container}', [AssetsController::class, 'index']);
 Route::name('assets.show')->get('assets/{asset_container}/{asset}', [AssetsController::class, 'show'])->where('asset', '.*');
 
 Route::get('collections/{collection}/tree', [CollectionTreeController::class, 'show']);
 Route::get('navs/{nav}/tree', [NavigationTreeController::class, 'show']);
 
+Route::get('ping', PingController::class);
+
 Route::get('{path?}', NotFoundController::class)->where('path', '.*');

src/Http/Controllers/API/PingController.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Statamic\Http\Controllers\API;
+
+class PingController
+{
+    public function __invoke()
+    {
+        return ['ping' => 'pong'];
+    }
+}

src/Http/Controllers/API/SitesController.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Statamic\Http\Controllers\API;
+
+use Statamic\Facades\Site;
+use Statamic\Http\Resources\API\SiteResource;
+
+class SitesController extends ApiController
+{
+    protected $resourceConfigKey = 'sites';
+
+    public function index()
+    {
+        $this->abortIfDisabled();
+
+        return app(SiteResource::class)::collection(Site::all()->values());
+    }
+}

src/Http/Resources/API/Resource.php

@@ -17,6 +17,7 @@ class Resource
         EntryResource::class,
         FormResource::class,
         GlobalSetResource::class,
+        SiteResource::class,
         TermResource::class,
         UserResource::class,
         TreeResource::class,

src/Http/Resources/API/SiteResource.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Statamic\Http\Resources\API;
+
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class SiteResource extends JsonResource
+{
+    /**
+     * Transform the resource into an array.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return array
+     */
+    public function toArray($request)
+    {
+        return [
+            'handle' => $this->resource->handle(),
+            'name' => $this->resource->name(),
+            'locale' => $this->resource->locale(),
+            'short_locale' => $this->resource->shortLocale(),
+            'url' => $this->resource->url(),
+        ];
+    }
+}

tests/API/APITest.php

@@ -18,6 +18,42 @@ class APITest extends TestCase
 {
     use PreventSavingStacheItemsToDisk;
 
+    #[Test]
+    public function it_cannot_query_sites_by_default()
+    {
+        $this->assertEndpointNotFound('/api/sites');
+    }
+
+    #[Test]
+    public function it_queries_sites()
+    {
+        Facades\Config::set('statamic.api.resources.sites', true);
+
+        $this->setSites([
+            'en' => ['name' => 'English', 'locale' => 'en_US', 'url' => 'http://test.com/'],
+            'fr' => ['name' => 'French', 'locale' => 'fr_FR', 'url' => 'http://fr.test.com/'],
+            'de' => ['name' => 'German', 'locale' => 'de_DE', 'url' => 'http://test.com/de/'],
+        ]);
+
+        $this
+            ->get('/api/sites')
+            ->assertSuccessful()
+            ->assertExactJson(['data' => [
+                ['handle' => 'en', 'name' => 'English', 'locale' => 'en_US', 'short_locale' => 'en', 'url' => 'http://test.com'],
+                ['handle' => 'fr', 'name' => 'French', 'locale' => 'fr_FR', 'short_locale' => 'fr', 'url' => 'http://fr.test.com'],
+                ['handle' => 'de', 'name' => 'German', 'locale' => 'de_DE', 'short_locale' => 'de', 'url' => 'http://test.com/de'],
+            ]]);
+    }
+
+    #[Test]
+    public function it_pongs_when_pinged()
+    {
+        $this
+            ->get('/api/ping')
+            ->assertSuccessful()
+            ->assertExactJson(['ping' => 'pong']);
+    }
+
     #[Test]
     public function not_found_responses_are_formatted_with_json()
     {

tests/API/ConfigTest.php

@@ -346,6 +346,23 @@ public function config_can_enable_some_forms_resources()
         $this->assertEndpointSuccessful('/api/forms/survey');
     }
 
+    #[Test]
+    public function config_can_enable_sites()
+    {
+        Facades\Config::set('statamic.api.resources.sites', true);
+
+        $this->assertEndpointSuccessful('/api/sites');
+        $this->assertEndpointDataCount('/api/sites', 1);
+    }
+
+    #[Test]
+    public function config_can_disable_sites()
+    {
+        Facades\Config::set('statamic.api.resources.sites', false);
+
+        $this->assertEndpointNotFound('/api/sites');
+    }
+
     #[Test]
     public function config_can_enable_all_users()
     {