symfony3
Werken met webservices

Rest API

Ik heb eerder documentatie op deze site geschreven om te beschrijven hoe webservices op Symfony kunnen worden gemaakt

Ik zal opnieuw een tutorial schrijven voor de symfony> = 3-versie.

We denken dat we een geïnstalleerde webserver hebben op een geconfigureerde versie van Symfony Framework . U moet ook componist (php-pakkettenmanager) hebben geïnstalleerd.

Om het eenvoudig te maken, als je componist hebt geïnstalleerd, typ je dit in een terminal / opdrachtprompt:

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

Hiermee wordt een nieuwe map met de naam "voorbeeld" in de huidige map gemaakt, met een standaardinstallatie van symfony framework.

U moet deze 2 bundels installeren: JMSSerializer-bundel (verlengt framework component serializer) en FOSRest-bundel (breidt framework component routing en controllers uit ...)

U kunt dit als volgt doen (in de voorbeeldmap):

composer require jms/serializer-bundle "~0.13"
composer require friendsofsymfony/rest-bundle

Vergeet ze niet te activeren in AppKernel!

Hier kunt u niet gebruiken:

composer create-project gimler/symfony-rest-edition --stability=dev example

Omdat het gebaseerd is op de Symfony 2.8-versie.

Maak eerst uw eigen ("Voorbeeld") bundel (in de Symfony-directory):

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

Stel je voor dat we CRUD (Maken / Lezen / Bijwerken / Verwijderen) van deze StackOverFlower-entiteit willen maken:

# 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

Configureer uw bundel:

#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 }

Genereer deze entiteit:

php bin/console doctrine:generate:entity StackOverFlower
php bin/console doctrine:schema:update --force

Maak een controller:

#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);
    }
}

Vertel me niet dat dit een dikke controller is, het is voor het voorbeeld !!!

Maak uw sjabloon:

#src/ExampleBundle/Resources/views/StackOverFlower.html.twig
{% if errors is defined %}
  {{ errors }}  
{% else %}
  {% if users is defined %}
    {{ users | serialize }}
  {% else %}
    {{ user | serialize }}
  {% endif %}
{% endif %}

U hebt zojuist uw eerste RESTFul API gemaakt !!!

Je kunt het testen op: http: //uw-servernaam/uw-symfony-path/app_dev.php/stackoverflower/new/test .

Zoals u in de database kunt zien, is een nieuwe gebruiker gemaakt met de naam: "test".

Je kunt een volledig werkend voorbeeld van deze code bekijken op mijn GitHub-account , een filiaal met meer echte routes ...

Dit is een heel eenvoudig voorbeeld, laat dat in productie-omgeving je api niet beschermen met apikey !!!

Een toekomstig voorbeeld misschien?