-
-
Notifications
You must be signed in to change notification settings - Fork 868
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: api-platform/json-hal component (#6621)
* feat: add hal support for laravel * feat: quick review * fix: typo & cs-fixer * fix: typo in composer.json * fix: cs-fixer & phpstan * fix: forgot about hal item normalizer, therefore there's no more createbook nor updatebook test as Hal is a readonly format
- Loading branch information
1 parent
00787f3
commit e370d20
Showing
5 changed files
with
221 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| { | ||
| "name": "api-platform/json-hal", | ||
| "description": "API Hal support", | ||
| "type": "library", | ||
| "keywords": [ | ||
| "REST", | ||
| "API", | ||
| "HAL" | ||
| ], | ||
| "homepage": "https://api-platform.com", | ||
| "license": "MIT", | ||
| "authors": [ | ||
| { | ||
| "name": "Kévin Dunglas", | ||
| "email": "kevin@dunglas.fr", | ||
| "homepage": "https://dunglas.fr" | ||
| }, | ||
| { | ||
| "name": "API Platform Community", | ||
| "homepage": "https://api-platform.com/community/contributors" | ||
| } | ||
| ], | ||
| "require": { | ||
| "php": ">=8.1", | ||
| "api-platform/state": "^3.4 || ^4.0", | ||
| "api-platform/metadata": "^3.4 || ^4.0", | ||
| "api-platform/serializer": "^3.4 || ^4.0" | ||
| }, | ||
| "autoload": { | ||
| "psr-4": { | ||
| "ApiPlatform\\Hal\\": "" | ||
| }, | ||
| "exclude-from-classmap": [ | ||
| "/Tests/" | ||
| ] | ||
| }, | ||
| "config": { | ||
| "preferred-install": { | ||
| "*": "dist" | ||
| }, | ||
| "sort-packages": true, | ||
| "allow-plugins": { | ||
| "composer/package-versions-deprecated": true, | ||
| "phpstan/extension-installer": true | ||
| } | ||
| }, | ||
| "extra": { | ||
| "branch-alias": { | ||
| "dev-main": "4.0.x-dev", | ||
| "dev-3.4": "3.4.x-dev" | ||
| }, | ||
| "symfony": { | ||
| "require": "^6.4 || ^7.1" | ||
| } | ||
| }, | ||
| "scripts": { | ||
| "test": "./vendor/bin/phpunit" | ||
| }, | ||
| "require-dev": { | ||
| "phpunit/phpunit": "^11.2" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the API Platform project. | ||
| * | ||
| * (c) Kévin Dunglas <dunglas@gmail.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace ApiPlatform\Laravel\Tests; | ||
|
|
||
| use ApiPlatform\Laravel\Test\ApiTestAssertionsTrait; | ||
| use Illuminate\Contracts\Config\Repository; | ||
| use Illuminate\Foundation\Application; | ||
| use Illuminate\Foundation\Testing\RefreshDatabase; | ||
| use Orchestra\Testbench\Concerns\WithWorkbench; | ||
| use Orchestra\Testbench\TestCase; | ||
| use Workbench\App\Models\Book; | ||
|
|
||
| class HalTest extends TestCase | ||
| { | ||
| use ApiTestAssertionsTrait; | ||
| use RefreshDatabase; | ||
| use WithWorkbench; | ||
|
|
||
| /** | ||
| * @param Application $app | ||
| */ | ||
| protected function defineEnvironment($app): void | ||
| { | ||
| tap($app['config'], function (Repository $config): void { | ||
| $config->set('api-platform.formats', ['jsonhal' => ['application/hal+json']]); | ||
| $config->set('api-platform.docs_formats', ['jsonhal' => ['application/hal+json']]); | ||
| }); | ||
| } | ||
|
|
||
| public function testGetEntrypoint(): void | ||
| { | ||
| $response = $this->get('/api/', ['accept' => ['application/hal+json']]); | ||
| $response->assertStatus(200); | ||
| $response->assertHeader('content-type', 'application/hal+json; charset=utf-8'); | ||
|
|
||
| $this->assertJsonContains( | ||
| [ | ||
| '_links' => [ | ||
| 'self' => ['href' => '/api'], | ||
| 'book' => ['href' => '/api/books'], | ||
| 'post' => ['href' => '/api/posts'], | ||
| 'sluggable' => ['href' => '/api/sluggables'], | ||
| 'vault' => ['href' => '/api/vaults'], | ||
| 'author' => ['href' => '/api/authors'], | ||
| ], | ||
| ], | ||
| $response->json() | ||
| ); | ||
| } | ||
|
|
||
| public function testGetCollection(): void | ||
| { | ||
| $response = $this->get('/api/books', ['accept' => 'application/hal+json']); | ||
| $response->assertStatus(200); | ||
| $response->assertHeader('content-type', 'application/hal+json; charset=utf-8'); | ||
| $this->assertJsonContains( | ||
| [ | ||
| '_links' => [ | ||
| 'first' => ['href' => '/api/books?page=1'], | ||
| 'self' => ['href' => '/api/books?page=1'], | ||
| 'last' => ['href' => '/api/books?page=2'], | ||
| ], | ||
| 'totalItems' => 10, | ||
| ], | ||
| $response->json() | ||
| ); | ||
| } | ||
|
|
||
| public function testGetBook(): void | ||
| { | ||
| $book = Book::first(); | ||
| $iri = $this->getIriFromResource($book); | ||
| $response = $this->get($iri, ['accept' => ['application/hal+json']]); | ||
| $response->assertStatus(200); | ||
| $response->assertHeader('content-type', 'application/hal+json; charset=utf-8'); | ||
| $this->assertJsonContains( | ||
| [ | ||
| 'name' => $book->name, // @phpstan-ignore-line | ||
| 'isbn' => $book->isbn, // @phpstan-ignore-line | ||
| '_links' => [ | ||
| 'self' => [ | ||
| 'href' => $iri, | ||
| ], | ||
| 'author' => [ | ||
| 'href' => '/api/authors/1', | ||
| ], | ||
| ], | ||
| ], | ||
| $response->json() | ||
| ); | ||
| } | ||
|
|
||
| public function testDeleteBook(): void | ||
| { | ||
| $book = Book::first(); | ||
| $iri = $this->getIriFromResource($book); | ||
| $response = $this->delete($iri, headers: ['accept' => 'application/hal+json']); | ||
| $response->assertStatus(204); | ||
| $this->assertNull(Book::find($book->id)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters