symfony3
Arbetar med webbtjänster

Rest API

Jag har tidigare skrivit dokumentation på denna webbplats för att beskriva hur man skapar webbtjänster på Symfony

Jag kommer att skriva igen en tutorial för symfony> = 3-versionen.

Vi tror att vi har en installerad webbserver på en konfigurerad version av Symfony Framework . Du måste också ha kompositör (php-pakethanteraren) installerad.

För att göra det enkelt, om du har installerat kompositör, skriv detta i en terminal / kommandotolk:

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

Detta skapar en ny katalog som heter "exempel" i den aktuella katalogen, med en standardinstallation av symfonyram.

Du måste installera de här två buntarna: JMSSerializer Bundle (utökar ramkomponentserier) och FOSRest Bundle (utökar routing och kontroller för ramkomponentkomponenter ...)

Du kan göra detta så här (i exempelkatalogen):

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

Glöm inte att aktivera dem i AppKernel!

Här kan du inte använda:

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

Eftersom det är baserat på Symfony 2.8-versionen.

Skapa först ditt eget paket ("Exempel") (i Symfony-katalogen):

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

Föreställ dig att vi vill göra CRUD (Skapa / läsa / uppdatera / radera) av denna StackOverFlower-enhet:

# 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

Konfigurera ditt paket:

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

Generera den här enheten:

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

Skapa en kontroller:

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

Berätta inte för mig att det är en fettkontroll, det är till exempel !!!

Skapa din mall:

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

Du har precis gjort ditt första RESTFul API !!!

Du kan testa det på: http: //your-server-name/your-symfony-path/app_dev.php/stackoverflower/new/test .

Som du ser i databasen har en ny användare skapats med namnet: "test".

Du kan se ett fullständigt fungerande exempel på den här koden på mitt GitHub-konto , en gren med mer riktiga rutter ...

Detta är ett mycket grundläggande exempel, låt inte det i produktionsmiljön, du måste skydda din api med apikey !!!

Ett framtida exempel kan vara?