creads/api2symfony-bundle

A Symfony2 bundle to automatically generate controllers from standard API specifications (RAML, Blueprint, Swagger...)

Api2Symfony Bundle

A Symfony2 bundle to automatically generate controllers from standard API specifications (RAML, Blueprint, Swagger...), _(*1)

BUT... We only support the following specification formats now:, _(*2)

• RAML

But we'd like to also support:, _(*3)

• Blueprint
• Swagger

This bundle uses the api2symfony library., _(*4)

Installation

Using composer:, _(*5)

composer require creads/api2symfony-bundle 1.0.*@dev, _(*6)

Register the bundle by updating AppKernel.php:, _(*7)

<?php

// in AppKernel::registerBundles()
if (in_array($this->getEnvironment(), ['dev', 'test'])) {
        // ...
        $bundles[] = new Creads\Api2SymfonyBundle\Api2SymfonyBundle();
        // ...
};

Use case

The bundle provides a command:, _(*8)

app/console.php api2symfony:generate:raml path/to/api.raml Some\\Namespace, _(*9)

Example

php app/console.php api2symfony:generate:raml path/to/api.raml Acme\\DemoBundle, _(*10)

New controller dumped at app/cache/dev/api2symfony/Acme/DemoBundle/1_0_1_alpha/PostsController.php, _(*11)

    #%RAML 0.8
    title: Api Example
    version: 1.0.1-alpha

    /posts:
      description: Collection of available post resource
      get:
        description: Get a list of post
      post:
        description: Create a new post
      /{id}:
        displayName: Post
        get:
          description: Get a single post
          responses:
            200:
              body:
                application/json:
                  example: |
                    {
                      "title": "An amazing news"
                    }
        delete:
          description: Delete a specific post
        /comments:
          description: Collection of available post's comments
          displayName: Comments
          get:
            description: Get list of comment for given post
          post:
            description: Comment a post

Generated code:, _(*12)

    <?php

    namespace Acme\DemoBundle\1_0_1_alpha;

    use Symfony\Bundle\FrameworkBundle\Controller\Controller;

    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;

    /**
     * Collection of available post resource
     *
     * This is an auto generated class provided by Creads\Api2Symfony PHP library.
     */
    class PostsController extends Controller
    {
        /**
         * Get a list of post
         *
         * @Route("/posts", name="get_posts")
         * @Method({"GET"})
         */
        public function getPostsAction()
        {

        }

        /**
         * Create a new post
         *
         * @Route("/posts", name="post_posts")
         * @Method({"POST"})
         */
        public function postPostsAction()
        {

        }

        /**
         * Get a single post
         *
         * @Route("/posts/{id}", name="get_posts_post")
         * @Method({"GET"})
         */
        public function getPostsPostAction($id)
        {
            return new Response('{"title": "An amazing news"}', 200, array('Content-Type' => 'application/json'));
        }

        /**
         * Delete a specific post
         *
         * @Route("/posts/{id}", name="delete_posts_post")
         * @Method({"DELETE"})
         */
        public function deletePostsPostAction($id)
        {

        }

        /**
         * Get list of comment for given post
         *
         * @Route("/posts/{id}/comments", name="get_posts_post_comments")
         * @Method({"GET"})
         */
        public function getPostsPostCommentsAction($id)
        {

        }

        /**
         * Comment a post
         *
         * @Route("/posts/{id}/comments", name="post_posts_post_comments")
         * @Method({"POST"})
         */
        public function postPostsPostCommentsAction($id)
        {

        }
    }