Permalink
314 lines (233 sloc) 9.76 KB

NelmioApiDocBundle

The NelmioApiDocBundle bundle allows you to generate documentation in the OpenAPI (Swagger) format and provides a sandbox to interactively experiment with the API.

What's supported?

This bundle supports Symfony route requirements, PHP annotations, Swagger-Php annotations, FOSRestBundle annotations and apps using Api-Platform.

For models, it supports the Symfony serializer , the JMS serializer and the willdurand/Hateoas library. It does also support Symfony form types.

Migrate from 2.x to 3.0

To migrate from 2.x to 3.0, just follow our guide.

Installation

Open a command console, enter your project directory and execute the following command to download the latest version of this bundle:

$ composer require nelmio/api-doc-bundle

Note

If you're not using Flex, then add the bundle to your kernel:

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...

            new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
        ];

        // ...
    }
}

To browse your documentation with Swagger UI, register the following route:

# app/config/routing.yml
app.swagger_ui:
    path: /api/doc
    methods: GET
    defaults: { _controller: nelmio_api_doc.controller.swagger_ui }

If you also want to expose it in JSON, register this route:

# app/config/routing.yml
app.swagger:
    path: /api/doc.json
    methods: GET
    defaults: { _controller: nelmio_api_doc.controller.swagger }

As you just installed the bundle, you'll likely see routes you don't want in your documentation such as /_profiler/. To fix this, you can filter the routes that are documented by configuring the bundle:

# app/config/config.yml
nelmio_api_doc:
    areas:
        path_patterns: # an array of regexps
            - ^/api(?!/doc$)
        host_patterns:
            - ^api\.

How does this bundle work?

It generates an OpenAPI documentation from your Symfony app thanks to Describers. One extracts data from SwaggerPHP annotations, one from your routes, etc.

If you configured the app.swagger_ui route above, you can browse your documentation at http://example.org/api/doc.

Using the bundle

You can configure global information in the bundle configuration documentation.info section (take a look at the OpenAPI 2.0 specification (formerly Swagger) to know the available fields):

nelmio_api_doc:
    documentation:
        host: api.example.com
        schemes: [http, https]
        info:
            title: My App
            description: This is an awesome app!
            version: 1.0.0
        securityDefinitions:
            Bearer:
                type: apiKey
                description: 'Value: Bearer {jwt}'
                name: Authorization
                in: header
        security:
            - Bearer: []

Note

If you're using Flex, this config is there by default. Don't forget to adapt it to your app!

To document your routes, you can use the SwaggerPHP annotations and the Nelmio\ApiDocBundle\Annotation\Model annotation in your controllers:

namespace AppBundle\Controller;

use AppBundle\Entity\User;
use AppBundle\Entity\Reward;
use Nelmio\ApiDocBundle\Annotation\Model;
use Nelmio\ApiDocBundle\Annotation\Security;
use Swagger\Annotations as SWG;
use Symfony\Component\Routing\Annotation\Route;

class UserController
{
    /**
     * List the rewards of the specified user.
     *
     * This call takes into account all confirmed awards, but not pending or refused awards.
     *
     * @Route("/api/{user}/rewards", methods={"GET"})
     * @SWG\Response(
     *     response=200,
     *     description="Returns the rewards of an user",
     *     @SWG\Schema(
     *         type="array",
     *         @SWG\Items(ref=@Model(type=Reward::class, groups={"full"}))
     *     )
     * )
     * @SWG\Parameter(
     *     name="order",
     *     in="query",
     *     type="string",
     *     description="The field used to order rewards"
     * )
     * @SWG\Tag(name="rewards")
     * @Security(name="Bearer")
     */
    public function fetchUserRewardsAction(User $user)
    {
        // ...
    }
}

The normal PHPdoc block on the controller method is used for the summary and description.

Use models

As shown in the example above, the bundle provides the @Model annotation. Use it instead of a definition reference and the bundle will deduce your model properties.

Note

A model can be a Symfony form type, a Doctrine ORM entity or a general PHP object.

This annotation has two options:

  • type to specify your model's type:

    /**
     * @SWG\Response(
     *     response=200,
     *     @Model(type=User::class)
     * )
     */
    
  • groups to specify the serialization groups used to (de)serialize your model:

    /**
     * @SWG\Response(
     *     response=200,
     *     @Model(type=User::class, groups={"non_sensitive_data"})
     * )
     */
    

Tip

When used at the root of @SWG\Response and @SWG\Parameter, @Model is automatically nested in a @SWG\Schema.

To use @Model directly within a @SWG\Schema, @SWG\Items or @SWG\Property, you have to use the $ref field:

/**
 * @SWG\Response(
 *     @SWG\Schema(ref=@Model(type=User::class))
 * )
 *
 * or
 *
 * @SWG\Response(
 *     @SWG\Schema(type="object",
 *         @SWG\Property(property="foo", ref=@Model(type=FooClass::class))
 *     )
 * )
 */

Symfony Form types

You can customize the documentation of a form field using the documentation option:

$builder->add('username', TextType::class, [
    'documentation' => [
        'type' => 'string', // would have been automatically detected in this case
        'description' => 'Your username.',
    ],
]);

See the OpenAPI 2.0 specification to see all the available fields of the documentation option.

General PHP objects

Tip

If you're not using the JMS Serializer, the Symfony PropertyInfo component is used to describe your models. It supports doctrine annotations, type hints, and even PHP doc blocks. It does also support serialization groups when using the Symfony serializer.

If you're using the JMS Serializer, the metadata of the JMS serializer are used by default to describe your models. Additional information is extracted from the PHP doc block comment, but the property types must be specified in the JMS annotations.

In case you prefer using the Symfony PropertyInfo component (you won't be able to use JMS serialization groups), you can disable JMS serializer support in your config:

nelmio_api_doc:
    models: { use_jms: false }

When using the JMS serializer combined with willdurand/Hateoas (and the BazingaHateoasBundle), HATEOAS metadata are automatically extracted

If you want to customize the documentation of an object's property, you can use @SWG\Property:

use Nelmio\ApiDocBundle\Annotation\Model;
use Swagger\Annotations as SWG;

class User
{
    /**
     * @var int
     * @SWG\Property(description="The unique identifier of the user.")
     */
    public $id;

    /**
     * @SWG\Property(type="string", maxLength=255)
     */
    public $username;

    /**
     * @SWG\Property(ref=@Model(type=User::class))
     */
    public $friend;
}

See the OpenAPI 2.0 specification to see all the available fields of @SWG\Property.

Learn more

If you need more complex features, take a look at:

.. toctree::
    :maxdepth: 1

    areas
    alternative_names
    customization
    faq