![<?php
namespace AppHttpActionApi;
final class GetThisWeeksGameSoftwareRelease
{
private $service;
public function __construct(ThisWeeksGameSoftwareRelease $service)
{
$this->service = $service;
}
public function __invoke(GetThisWeeksGameSoftwareReleaseRequest $request): Responder
{
$validated = $request->validated();
$limit = $validated['limit'] ?? 3;
$offset = $validated['offset'] ?? 0;
$collection = $this->service->getCollection((int) $limit, (int) $offset);
return new GetThisWeeksGameSoftwareReleaseResponder($collection);
}
}](https://image.slidesharecdn.com/laravelapi-171124115309/85/Laravel-API-15-320.jpg)
![class RouteServiceProvider extends ServiceProvider
{
public function register()
{
parent::register();
/** @var Router $router */
$router = $this->app['router'];
$router->group(['prefix' => 'api'], function (Router $router) {
$router->get(
'/game_software/release/week',
['uses' => GetThisWeeksGameSoftwareRelease::class]
);
});
}
}](https://image.slidesharecdn.com/laravelapi-171124115309/85/Laravel-API-16-320.jpg)
![<?php
namespace AppHttpRequestApi;
use IlluminateFoundationHttpFormRequest;
class GetThisWeeksGameSoftwareReleaseRequest extends FormRequest
{
public function authorize(): bool
{
return true;
}
public function rules(): array
{
return [
'limit' => 'integer|min:1',
'offset' => 'integer|min:0',
];
}
}](https://image.slidesharecdn.com/laravelapi-171124115309/85/Laravel-API-19-320.jpg)
![ActionClass
メソッドインジェクションしたFormRequestは屡にバリデ`ションg
みのパラメ`タを函誼できる。
Laraevl5.5からは ->validated(); でバリデ`ション協xされてかつ、バ
リデ`ションされた､里瀏ゝ辰辛嬬
public function __invoke(GetThisWeeksGameSoftwareReleaseRequest $request): Responder
{
$validated = $request->validated();
$limit = $validated['limit'] ?? 3;
$offset = $validated['offset'] ?? 0;
$collection = $this->service->getCollection((int) $limit, (int) $offset);
return new Responder($collection);
}](https://image.slidesharecdn.com/laravelapi-171124115309/85/Laravel-API-20-320.jpg)
![Laravelでアノテ`ションを旋喘できるようにする
<?php
namespace AppProviders;
use DoctrineCommonAnnotationsAnnotationReader;
use DoctrineCommonAnnotationsAnnotationRegistry;
use IlluminateSupportServiceProvider;
class AnnotationRegisterServiceProvider extends ServiceProvider
{
public function register()
{
$loader = require base_path().'/vendor/autoload.php';
AnnotationRegistry::registerLoader([$loader, 'loadClass']);
}
}
AppProvidersAnnotationRegisterServiceProvider::class,](https://image.slidesharecdn.com/laravelapi-171124115309/85/Laravel-API-30-320.jpg)
![<?php
namespace AppHttpResponder;
use HateoasHateoas;
use HateoasHateoasBuilder;
use IlluminateHttpResponse;
use HateoasUrlGeneratorCallableUrlGenerator;
trait HateoasResponder
{
protected function hal(
HateoasResource $resource,
int $status = 200,
array $headers = []
): Response
{
return new Response(
$this->builder()->serialize($resource, 'json'),
$status,
array_merge(['Content-Type' => 'application/hal+json'], $headers)
);
}](https://image.slidesharecdn.com/laravelapi-171124115309/85/Laravel-API-34-320.jpg)
![public function findReleaseThisWeek(int $limit, int $offset): GameSoftwareCollection
{
$data = $this->criteria->getReleaseThisWeek($limit, $offset);
$collection = new GameSoftwareCollection();
foreach ($data as $item) {
$hydrator = new ReflectionHydrator();
$namingStrategy = new CompositeNamingStrategy([
'release_date' => new MapNamingStrategy([
'release_date' => 'releaseDate'
]),
'retail_price_desired' => new MapNamingStrategy([
'retail_price_desired' => 'retailPriceDesired'
]),
]);
$hydrator->setNamingStrategy($namingStrategy);
$gameSoft = $hydrator->hydrate(
$item,
new GameSoftware()
);
$collection->add($gameSoft);
}
return $collection;
}](https://image.slidesharecdn.com/laravelapi-171124115309/85/Laravel-API-39-320.jpg)
![HATEOASで旋喘したアノテ`ション鞠hでSwagger PHPのアノテ`シ
ョン @SWG のClassがつからないエラ`がk伏するのでこのアノテ`シ
ョンはIgnoreさせる
class AnnotationRegisterServiceProvider extends ServiceProvider
{
public function register()
{
$loader = require base_path().'/vendor/autoload.php';
AnnotationRegistry::registerLoader([$loader, 'loadClass']);
AnnotationReader::addGlobalIgnoredNamespace('SWG'); // Add
}
}](https://image.slidesharecdn.com/laravelapi-171124115309/85/Laravel-API-48-320.jpg)
![Collectionの協x
/**
* Class GameSoftwareCollection
* @package AppDomainCollection
* @SWGDefinition(
* type="object",
* @SWGXml(name="GameSoftwareCollection")
* )
*/
class GameSoftwareCollection implements EntityCollectionInterface, HateoasResource
{
/**
* @var GameSoftware[]
* @SerializedName("game_software")
* @SWGProperty(
* property="game_software",
* @SWGXml(name="GameSoftware", wrapped=true)
* )
*/
protected $entities = [];](https://image.slidesharecdn.com/laravelapi-171124115309/85/Laravel-API-52-320.jpg)
晦温姻温厩艶鉛て?粥永鴛協吶を砿尖する
- 2. Pro le Kenjiro Kubota istyle.inc 徭各テクノロジ`云何y毅輝 PHP, HHVM/Hack, Javascript
- 9. 未まえて、書晩すこと ADR = APIg廾の REST API Level3 = レスポンス侘塀の Swagger PHP = APIドキュメントの
- 10. ADR
- 11. ADR Action Domain Responder の待です。Laralab vol.1という茶氏でB初させていただきました。 Responsableを聞ったADRg廾 /KenjiroKubota/responsableadr MVCから塗伏したUIア`キテクチャパタ`ン
- 12. Model Domain View Responder Controller Action
- 15. <?php namespace AppHttpActionApi; final class GetThisWeeksGameSoftwareRelease { private $service; public function __construct(ThisWeeksGameSoftwareRelease $service) { $this->service = $service; } public function __invoke(GetThisWeeksGameSoftwareReleaseRequest $request): Responder { $validated = $request->validated(); $limit = $validated['limit'] ?? 3; $offset = $validated['offset'] ?? 0; $collection = $this->service->getCollection((int) $limit, (int) $offset); return new GetThisWeeksGameSoftwareReleaseResponder($collection); } }
- 16. class RouteServiceProvider extends ServiceProvider { public function register() { parent::register(); /** @var Router $router */ $router = $this->app['router']; $router->group(['prefix' => 'api'], function (Router $router) { $router->get( '/game_software/release/week', ['uses' => GetThisWeeksGameSoftwareRelease::class] ); }); } }
- 18. (おまけ)酷看姻馨檎艶援顎艶壊岳
- 19. <?php namespace AppHttpRequestApi; use IlluminateFoundationHttpFormRequest; class GetThisWeeksGameSoftwareReleaseRequest extends FormRequest { public function authorize(): bool { return true; } public function rules(): array { return [ 'limit' => 'integer|min:1', 'offset' => 'integer|min:0', ]; } }
- 20. ActionClass メソッドインジェクションしたFormRequestは屡にバリデ`ションg みのパラメ`タを函誼できる。 Laraevl5.5からは ->validated(); でバリデ`ション協xされてかつ、バ リデ`ションされた､里瀏ゝ辰辛嬬 public function __invoke(GetThisWeeksGameSoftwareReleaseRequest $request): Responder { $validated = $request->validated(); $limit = $validated['limit'] ?? 3; $offset = $validated['offset'] ?? 0; $collection = $this->service->getCollection((int) $limit, (int) $offset); return new Responder($collection); }
- 21. Responder
- 22. <?php namespace AppHttpResponderApi; use AppHttpResponderHateoasResponder; use IlluminateContractsSupportResponsable; use AppDomainCollectionGameSoftwareCollection; class GetThisWeeksGameSoftwareReleaseResponder implements Responsable { use HateoasResponder; private $resource; public function __construct(GameSoftwareCollection $collection) { $this->resource = $collection; } public function toResponse($request): IlluminateHttpResponse { return $this->hal($this->resource); } }
- 23. REST API Level3
- 25. REST API Model Level 0 HTTPを喘いてXMLレスポンスを卦抜すること Level 1 URLでリソ`スを燕すこと Level 2 HTTPメソッドを屎しく聞い蛍けること Level 3 ハイパ`メディアコントロ`ル
- 27. HATEOAS Hypermedia As The Engine Of Application State
- 29. willdurand/hateoas https://github.com/willdurand/Hateoas アノテ`ションを弖紗することでレスポンスパラメ`タをするライ ブラリ $ composer require willdurand/hateoas
- 30. Laravelでアノテ`ションを旋喘できるようにする <?php namespace AppProviders; use DoctrineCommonAnnotationsAnnotationReader; use DoctrineCommonAnnotationsAnnotationRegistry; use IlluminateSupportServiceProvider; class AnnotationRegisterServiceProvider extends ServiceProvider { public function register() { $loader = require base_path().'/vendor/autoload.php'; AnnotationRegistry::registerLoader([$loader, 'loadClass']); } } AppProvidersAnnotationRegisterServiceProvider::class,
- 31. Entity <?php namespace AppDomainEntity; use AppHttpResponderHateoasResource; use PHPMentorsDomainKataEntityEntityInterface; class GameSoftware implements EntityInterface, HateoasResource { protected $id; protected $title; protected $description; protected $releaseDate; protected $price; protected $retailPriceDesired; protected $platform; protected $thumbnail; }
- 32. Add Annotation /** * Class GameSoftware * @package AppDomainEntity * @HateoasRelation( * "self", * href = "expr('/api/game_software/' ~ object.getId())" * ) * @HateoasRelation( * "page", * href = "expr('/game_software/' ~ object.getId())" * ) */ class GameSoftware implements EntityInterface, HateoasResource {
- 33. /** * @var string * @Accessor("getReleaseDate") */ protected $releaseDate; /** * @var int * @Type("int") */ protected $price; public function getId(): int { return $this->id; } public function getReleaseDate(string $format = "Y-m-d H:i:s"): string { return (new DateTime($this->releaseDate))->format($format); }
- 34. <?php namespace AppHttpResponder; use HateoasHateoas; use HateoasHateoasBuilder; use IlluminateHttpResponse; use HateoasUrlGeneratorCallableUrlGenerator; trait HateoasResponder { protected function hal( HateoasResource $resource, int $status = 200, array $headers = [] ): Response { return new Response( $this->builder()->serialize($resource, 'json'), $status, array_merge(['Content-Type' => 'application/hal+json'], $headers) ); }
- 35. protected function builder(): Hateoas { return HateoasBuilder::create() ->setUrlGenerator( null, new CallableUrlGenerator(function ($route, array $parameters) { return route($route, $parameters); }) ) ->build(); } }
- 36. <?php namespace AppHttpResponderApi; use AppHttpResponderHateoasResponder; use IlluminateContractsSupportResponsable; use AppDomainCollectionGameSoftwareCollection; class GetThisWeeksGameSoftwareReleaseResponder implements Responsable { use HateoasResponder; private $resource; public function __construct(GameSoftwareCollection $collection) { $this->resource = $collection; } public function toResponse($request): IlluminateHttpResponse { return $this->hal($this->resource); } }
- 37. こんな湖じのレスポンスになります。 { "id": 1, "title": "ス`パ`マリオオデッセイ", "description": "マリオ、弊順の唾へ。Nintendo Switch鬚吋愁侫箸撲戴3Dマリオが鞠します。´", "release_date": "2017-10-27 00:00:00", "price": 5545, "retail_price_desired": 6458, "platform": "Nintendo Switch", "thumbnail": "https://images-na.ssl-images-amazon.com/images/I/´.jpg", "_links": { "self": { "href": "/api/game_software/1" }, "page": { "href": "/game_software/1" } } }
- 39. public function findReleaseThisWeek(int $limit, int $offset): GameSoftwareCollection { $data = $this->criteria->getReleaseThisWeek($limit, $offset); $collection = new GameSoftwareCollection(); foreach ($data as $item) { $hydrator = new ReflectionHydrator(); $namingStrategy = new CompositeNamingStrategy([ 'release_date' => new MapNamingStrategy([ 'release_date' => 'releaseDate' ]), 'retail_price_desired' => new MapNamingStrategy([ 'retail_price_desired' => 'retailPriceDesired' ]), ]); $hydrator->setNamingStrategy($namingStrategy); $gameSoft = $hydrator->hydrate( $item, new GameSoftware() ); $collection->add($gameSoft); } return $collection; }
- 41. Swagger PHP
- 42. Swaggerとは https://swagger.io THE WORLD'S MOST POPULAR API TOOLING RESTful APIのドキュメントや、サ`バ、クライアントコ`ド、エディ タ、またそれらをQうための碧などを戻工するフレ`ムワ`ク Swagger Speci cationをSwagger UIにiみzませることで協xを伏 撹する
- 44. Swagger PHPではアノテ`ションを旋喘して Swagger Speci 界温岳庄看稼(逮壊看稼)を伏撹
- 45. g廾 = 協xができる
- 46. DarkaOnLine/L5-Swagger https://github.com/DarkaOnLine/L5-Swagger LaravelでSwaggerPHPを聞うライブラリ ArtisanコマンドでSwagger Speci cationを伏撹してSwaggerUIにm喘 したペ`ジが燕幣できる $ composer require "darkaonline/l5-swagger:5.5.*" L5SwaggerL5SwaggerServiceProvider::class,
- 47. _kh廠のみ旋喘したいのでProviderでLocalとDeveloph廠の栽の み鞠hする $env = $this->app->environment(); if ($env === 'develop' || $env === 'local') { $this->app->register(L5SwaggerL5SwaggerServiceProvider::class); } $ php artisan l5-swagger:publish con g/l5-swagger.php public/vendor/l5-swagger resources/views/vendor/l5-swagger 駅勣なファイルをpublishで卞
- 48. HATEOASで旋喘したアノテ`ション鞠hでSwagger PHPのアノテ`シ ョン @SWG のClassがつからないエラ`がk伏するのでこのアノテ`シ ョンはIgnoreさせる class AnnotationRegisterServiceProvider extends ServiceProvider { public function register() { $loader = require base_path().'/vendor/autoload.php'; AnnotationRegistry::registerLoader([$loader, 'loadClass']); AnnotationReader::addGlobalIgnoredNamespace('SWG'); // Add } }
- 49. Modelの協x /** * Class GameSoftware * @package AppDomainEntity * @HateoasRelation( * "self", * href = "expr('/api/game_software/' ~ object.getId())" * ) * @HateoasRelation( * "page", * href = "expr('/game_software/' ~ object.getId())" * ) * @SWGDefinition( * type="object", * @SWGXml(name="GameSoftware") * ) */ class GameSoftware implements EntityInterface, HateoasResource
- 50. プロパティのアノテ`ション /** * @var int * @SWGProperty(format="int64") */ protected $id; /** * @var string * @SWGProperty() */ protected $title;
- 51. /** * @SWGProperty( * property="_links", * type="object", * @SWGProperty( * property="self", * type="object", * @SWGProperty( * property="href", * type="string" * ) * ), * @SWGProperty( * property="page", * type="object", * @SWGProperty( * property="href", * type="string" * ) * ) * ) */
- 52. Collectionの協x /** * Class GameSoftwareCollection * @package AppDomainCollection * @SWGDefinition( * type="object", * @SWGXml(name="GameSoftwareCollection") * ) */ class GameSoftwareCollection implements EntityCollectionInterface, HateoasResource { /** * @var GameSoftware[] * @SerializedName("game_software") * @SWGProperty( * property="game_software", * @SWGXml(name="GameSoftware", wrapped=true) * ) */ protected $entities = [];
- 53. Responseの協x (ResponderClass) /** * @param IlluminateHttpRequest $request * @return IlluminateHttpResponse * @SWGResponse( * response="GetThisWeeksGameSoftwareReleaseResponder", * description="書Lk咾離鴬`ムを卦す", * @SWGSchema(ref="#/definitions/GameSoftwareCollection") * ) */ public function toResponse($request): IlluminateHttpResponse { return $this->hal($this->resource); }
- 54. RequestParameterの協x /** * @SWGParameter( * parameter="GetThisWeeksGameSoftwareReleaseRequest_limit", * name="limit", * description="函誼周方", * in="query", * required=false, * type="integer", * format="int32" * ) * @SWGParameter( * parameter="GetThisWeeksGameSoftwareReleaseRequest_offset", * name="offset", * description="函誼了崔", * in="query", * required=false, * type="integer", * format="int32" * ) */ public function rules(): array
- 55. Endpointの協x /** * Class GetThisWeeksGameSoftwareRelease * @package AppHttpActionApi * @SWGGet( * path="/game_software/release/week", * summary="書Lk咾離鴬`ムソフト", * description="", * consumes={"application/json"}, * produces={"application/hal+json"}, * @SWGParameter(ref="#/parameters/GetThisWeeksGameSoftwareReleaseRequest_limit"), * @SWGParameter(ref="#/parameters/GetThisWeeksGameSoftwareReleaseRequest_offset"), * @SWGResponse( * response="default", * ref="#/responses/GetThisWeeksGameSoftwareReleaseResponder" * ) * ) */ final class GetThisWeeksGameSoftwareRelease
- 56. swagger.jsonの伏撹 $ php artisan l5-swagger:generate _kh廠にデプロイするHにg佩 もしくは config/l5-swagger.php の 'generate_always' => true にすることで SwaggerUIにアクセスするたびに伏撹されます。 /api/documentation にアクセスするとSwaggerUIが婢_される。 エンドポイントを筝したい栽は config/l5-swagger.php の 'api' => 'api/documentation', の朕から筝できます。
- 58. thanks :)