サーチ…
レストAPI
symfonyでWebサービスを作成する方法を説明するために、私は以前このサイトの文書を書いています
symfony> = 3バージョンのチュートリアルをもう一度書きます。
Symfony Frameworkの設定済みバージョンにはWebサーバーがインストールされていると思います。 作曲家 (PHPパッケージマネージャー)もインストールしておく必要があります。
簡単にするには、コンポーザをインストールしている場合は、ターミナル/コマンドプロンプトで次のように入力します。
composer create-project symfony/framework-standard-edition example "3.1.*"
これにより、現在のディレクトリにsymfonyフレームワークの標準インストールがある "example"という新しいディレクトリが作成されます。
この2バンドルをインストールする必要があります:JMSSerializerバンドル(フレームワークコンポーネントシリアライザを拡張)とFOSRestバンドル(フレームワークコンポーネントのルーティングとコントローラを拡張する...)
これは次のように(サンプルディレクトリ内で)行うことができます:
composer require jms/serializer-bundle "~0.13"
composer require friendsofsymfony/rest-bundle
AppKernelでそれらを有効にすることを忘れないでください!
ここでは使用できません:
composer create-project gimler/symfony-rest-edition --stability=dev example
Symfony 2.8のバージョンに基づいているからです。
まず、独自の( "Example")Bundleを(Symfonyディレクトリに)作成します:
php bin/console generate:bundle
php bin/console doctrine:create:database
このStackOverFlower EntityのCRUD(Create / Read / Update / Delete)をしたいとします。
# src/ExampleBundle/Resources/config/doctrine/StackOverFlower.orm.yml
ExampleBundle\Entity\StackOverFlower:
type: entity
table: stackoverflower
id:
id:
type: integer
generator: { strategy: AUTO }
fields:
name:
type: string
length: 100
バンドルを設定する:
#app/config/config.yml
fos_rest:
format_listener:
rules:
- { path: '^/stackoverflower', priorities: ['xml', 'json'], fallback_format: xml, prefer_extension: true }
- { path: '^/', priorities: [ 'text/html', '*/*'], fallback_format: html, prefer_extension: true }
このエンティティを生成する:
php bin/console doctrine:generate:entity StackOverFlower
php bin/console doctrine:schema:update --force
コントローラを作る:
#src/ExampleBundle/Controller/StackOverFlowerController.php
namespace ExampleBundle\Controller;
use FOS\RestBundle\Controller\FOSRestController;
use Symfony\Component\HttpFoundation\Request;
use FOS\RestBundle\Controller\Annotations\Get;
use FOS\RestBundle\Controller\Annotations\Post;
use FOS\RestBundle\Controller\Annotations\Delete;
use ExampleBundle\Entity\StackOverFlower;
class StackOverFlowerController extends FOSRestController
{
/**
* findStackOverFlowerByRequest
*
* @param Request $request
* @return StackOverFlower
* @throws NotFoundException
*/
private function findStackOverFlowerByRequest(Request $request) {
$id = $request->get('id');
$user = $this->getDoctrine()->getManager()->getRepository("ExampleBundle:StackOverFlower")->findOneBy(array('id' => $id));
return $user;
}
/**
* validateAndPersistEntity
*
* @param StackOverFlower $user
* @param Boolean $delete
* @return View the view
*/
private function validateAndPersistEntity(StackOverFlower $user, $delete = false) {
$template = "ExampleBundle:StackOverFlower:example.html.twig";
$validator = $this->get('validator');
$errors_list = $validator->validate($user);
if (0 === count($errors_list)) {
$em = $this->getDoctrine()->getManager();
if ($delete === true) {
$em->remove($user);
} else {
$em->persist($user);
}
$em->flush();
$view = $this->view($user)
->setTemplateVar('user')
->setTemplate($template);
} else {
$errors = "";
foreach ($errors_list as $error) {
$errors .= (string) $error->getMessage();
}
$view = $this->view($errors)
->setTemplateVar('errors')
->setTemplate($template);
}
return $view;
}
/**
* newStackOverFlowerAction
*
* @Get("/stackoverflower/new/{name}")
*
* @param Request $request
* @return String
*/
public function newStackOverFlowerAction(Request $request)
{
$user = new StackOverFlower();
$user->setName($request->get('name'));
$view = $this->validateAndPersistEntity($user);
return $this->handleView($view);
}
/**
* editStackOverFlowerAction
*
* @Get("/stackoverflower/edit/{id}/{name}")
*
* @param Request $request
* @return type
*/
public function editStackOverFlowerAction(Request $request) {
$user = $this->findStackOverFlowerByRequest($request);
if (! $user) {
$view = $this->view("No StackOverFlower found for this id:". $request->get('id'), 404);
return $this->handleView($view);
}
$user->setName($request->get('name'));
$view = $this->validateAndPersistEntity($user);
return $this->handleView($view);
}
/**
* deleteStackOverFlowerAction
*
* @Get("/stackoverflower/delete/{id}")
*
* @param Request $request
* @return type
*/
public function deleteStackOverFlowerAction(Request $request) {
$user = $this->findStackOverFlowerByRequest($request);
if (! $user) {
$view = $this->view("No StackOverFlower found for this id:". $request->get('id'), 404);
return $this->handleView();
}
$view = $this->validateAndPersistEntity($user, true);
return $this->handleView($view);
}
/**
* getStackOverFlowerAction
*
* @Get("/stackoverflowers")
*
* @param Request $request
* @return type
*/
public function getStackOverFlowerAction(Request $request) {
$template = "ExampleBundle:StackOverFlower:example.html.twig";
$users = $this->getDoctrine()->getManager()->getRepository("ExampleBundle:StackOverFlower")->findAll();
if (0 === count($users)) {
$view = $this->view("No StackOverFlower found.", 404);
return $this->handleView();
}
$view = $this->view($users)
->setTemplateVar('users')
->setTemplate($template);
return $this->handleView($view);
}
}
太ったコントローラーだと教えてください。それは例です!
テンプレートを作成する:
#src/ExampleBundle/Resources/views/StackOverFlower.html.twig
{% if errors is defined %}
{{ errors }}
{% else %}
{% if users is defined %}
{{ users | serialize }}
{% else %}
{{ user | serialize }}
{% endif %}
{% endif %}
あなたはあなたの最初のRESTFul APIを作ったばかりです!
あなたはhttp://your-server-name/your-symfony-path/app_dev.php/stackoverflower/new/testでそれをテストすることができます。
データベースに表示されているように、「test」という名前の新しいユーザーが作成されました。
私のGitHubアカウント 、より実際のルートを持つ1つの支店でこのコードの完全な実例を見ることができます...
これは非常に基本的な例です。プロダクション環境では許可しないでください。apikeyを使用してAPIを保護する必要があります。
将来の例は、ありますか?