symfony3
Работа с веб-службами

Открытый API

Ранее я писал документацию на этом сайте, чтобы описать, как сделать веб-службы на Symfony

Я снова напишу учебник для версии symfony> = 3.

Мы считаем, что у нас установлен установленный веб-сервер на настроенной версии Symfony Framework . У вас также должен быть установлен композитор (менеджер пакетов php).

Чтобы сделать это простым, если у вас установлен композитор, введите его в командной строке терминала / командной строки:

composer create-project symfony/framework-standard-edition example "3.1.*"

Это создаст новый каталог с именем «example» в текущем каталоге со стандартной установкой Symfony framework.

Вы должны установить это 2 Bundles: JMSSerializer Bundle (расширяет программный сериализатор компонентов) и FOSRest Bundle (расширяет маршрутизацию и контроллеры компонентов) ...

Вы можете сделать это так (в каталоге примеров):

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.

Сначала создайте свой собственный («Пример») Bundle (в каталоге Symfony):

php bin/console generate:bundle
php bin/console doctrine:create:database

Представьте, что мы хотим сделать CRUD (Create / Read / Update / Delete) этого объекта StackOverFlower:

# 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 , одной ветви с более реальными маршрутами ...

Это очень простой пример, не позволяйте этому в сфере производства, вы должны защитить свой api с помощью apikey !!!

Может быть, будущий пример?