harmbandstra/swagger-ui-bundle

Exposes swagger UI inside your Symfony project through a route (eg. /docs)

Monday, July 9, 2018
by harmbandstra
Repository
1 Watchers
10 Stars
33,902 Installations

PHP
0 Dependents
0 Suggesters
8 Forks
0 Open issues
20 Versions
31 % Grown

The README.md

, _(*1)

Swagger UI Bundle

Expose swagger-ui inside your symfony project through a route (eg. /docs), just like nelmio api docs, without the need for node., _(*2)

Just add a reference to your OpenAPI Yaml or JSON specification, and enjoy swagger-ui in all it's glory., _(*3)

After installation and configuration, just start your local webserver, and navigate to /docs or /docs/my_swagger_spec.yml., _(*4)

Compatibility

If you need symfony 2.3 - 2.6 support, use version 1.x.
If you need symfony 2.7 - 3.x support, or php 5.x use version 2.x.
For symfony 3.3 and later with PHP > 7.0 use version 3.x.
For symfony 4.0 and later with PHP => 7.1.3 use version 4.x.
For PHP > 8.0 user version > 4.4

NOTE Since version 3.1, support for symfony 4 on the 3.x branch has been dropped. Use the 4.x branch instead., _(*5)

Installation

Install with composer in dev environment:, _(*6)

$ composer require harmbandstra/swagger-ui-bundle --dev, _(*7)

Make sure swagger-ui assets are copied to web/bundles by adding the HarmBandstra\SwaggerUiBundle\Composer\ScriptHandler::linkAssets composer hook before the Sensio\Bundle\DistributionBundle\Composer\ScriptHandler::installAssets hook in your composer.json., _(*8)

{
  "scripts": {
    "symfony-scripts": [
        "HarmBandstra\\SwaggerUiBundle\\Composer\\ScriptHandler::linkAssets",
        "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets"
    ],
    "post-install-cmd": ["@symfony-scripts"],
    "post-update-cmd": ["@symfony-scripts"]
}

If the scripts section in composer.json looks like this (symfony 4):, _(*9)

    "scripts": {
        "auto-scripts": {
            "cache:clear": "symfony-cmd",
            "assets:install %PUBLIC_DIR%": "symfony-cmd"
        },
        "post-install-cmd": [
            "@auto-scripts"
        ],
        "post-update-cmd": [
            "@auto-scripts"
        ]
    },

Add the composer hook like this:, _(*10)

    "scripts": {
        "auto-scripts": {
            "cache:clear": "symfony-cmd",
            "assets:install %PUBLIC_DIR%": "symfony-cmd"
        },
        "post-install-cmd": [
            "HarmBandstra\\SwaggerUiBundle\\Composer\\ScriptHandler::linkAssets",
            "@auto-scripts"
        ],
        "post-update-cmd": [
            "HarmBandstra\\SwaggerUiBundle\\Composer\\ScriptHandler::linkAssets",
            "@auto-scripts"
        ]
    },

Enable bundle in app/AppKernel.php(Symfony 3):, _(*11)

<?php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        // ...

        if (in_array($this->getEnvironment(), ['dev', 'test'], true)) {
            // ...
            $bundles[] = new HarmBandstra\SwaggerUiBundle\HBSwaggerUiBundle();
        }

        // ...
    }
}

Enable bundle in config/bundles.php(Symfony 4):, _(*12)

<?php

return [
    // ...
    HarmBandstra\SwaggerUiBundle\HBSwaggerUiBundle::class => ['dev' => true]
];

Add the route where swagger-ui will be available in routing_dev.yml:, _(*13)

_swagger-ui:
    resource: '@HBSwaggerUiBundle/Resources/config/routing.yml'
    prefix: /docs

Configuration (Symfony 3)

In your config.yml, link to the swagger spec., _(*14)

Specify the directory where your swagger files reside. You can access multiple files through the endpoint like /docs/my_swagger_spec.json. Under files you specify which files should be exposed., _(*15)

The first file in the array is the default one and it will be the file the /docs endpoint will redirect to. For this file you have the option to specify an absolute path to the .json spec file ("/_swagger/swagger.json") or a URL ("https://example.com/swagger.json")., _(*16)

hb_swagger_ui:
  directory: "%kernel.root_dir%/../docs/"
  files:
    - "/_swagger/swagger.json"
    - "my_swagger_spec.yml"
    - "my_other_swagger_spec.json"

Optional: If you want to have a default configuration in place for Swagger UI, place a config.json in the same directory as the swagger files, and add it to the configuration. It will be loaded automatically by appending it as the query parameter configUrl., _(*17)

hb_swagger_ui:
  configFile: "config.json"

Optional: If you serve your project from a different directory than the vhost root, you can overwrite the asset URL path with the assetUrlPath configuration. Be sure to add a leading and trailing slash., _(*18)

hb_swagger_ui:
  assetUrlPath: '/my-vhost-sub-directory/bundles/hbswaggerui/'

Configuration (Symfony 4, 5 and 6)

Create a file hb_swagger_ui.yaml in config/packages. Follow the rest of the steps for configuration in Symfony 3., _(*19)

The Versions

09/07 2018

2.x-dev

2.9999999.9999999.9999999-dev https://github.com/harmbandstra/swagger-ui-bundle

Exposes swagger UI inside your Symfony project through a route (eg. /docs)

library swagger-ui-bundle

Exposes swagger UI inside your Symfony project through a route (eg. /docs)

harmbandstra/swagger-ui-bundle

The README.md

Swagger UI Bundle

Compatibility

Installation

Configuration (Symfony 3)

Configuration (Symfony 4, 5 and 6)

The Versions

2.x-dev

The Requires

The Development Requires

2.1.2

The Requires

The Development Requires

dev-master

The Requires

The Development Requires

3.x-dev

The Requires

The Development Requires

3.0.1

The Requires

The Development Requires

3.0.0

The Requires

The Development Requires

2.1.1

The Requires

The Development Requires

2.1.0

The Requires

The Development Requires

2.0.0

The Requires

The Development Requires

1.x-dev

The Requires

The Development Requires

1.0.2

The Requires

The Development Requires

1.0.1

The Requires

The Development Requires

1.0.0

The Requires

The Development Requires

0.3

The Requires

The Development Requires

0.2.2

The Requires

The Development Requires

0.2.1

The Requires

The Development Requires

0.2

The Requires

The Development Requires

0.1.2

The Requires

The Development Requires

0.1.1

The Requires

0.1

The Requires