umbrella-anton-kasian/api-doc-bundle

Another view template for the NelmioApiDocBundle that generates documentation for your REST API from annotations

Maintainers

Details

github.com/umbrella-anton-kasian/api-doc-bundle

Source

Issues

Installs: 18

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

Language:JavaScript

Type:symfony-bundle

dev-master 2018-05-31 13:27 UTC

Requires

MIT af26513154f9e839436e8e62cf8df3a1a494c55a

  • Denis Zolotarev
  • Evgeny Nefedkin
  • Anton Kasyan

documentationrestapidoc

This package is not auto-updated.

Last update: 2024-05-04 16:16:02 UTC

README

Another view template for the NelmioApiDocBundle that allows you to generate a decent documentation for your APIs.

Installation

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

composer require umbrella-anton-kasian/api-doc-bundle

Add the bundle to your kernel::

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

                new Umbrella\ApiDocBundle\UmbrellaApiDocBundle(),
            ];

            // ...
        }
    }

Add routing:

    UmbrellaApiDocBundle:
        resource: "@UmbrellaApiDocBundle/Resources/config/routing.yml"
        prefix:   /api/doc