/natural-swagger-php

Primary LanguagePHP

NaturalSwagger (PHP)

Build Status Scrutinizer Code Quality Code Intelligence Status Total Downloads Latest Stable Version

The NaturalSwagger allows you to generate a decent documentation for your APIs. This library is based on zircote/swagger-php and swagger-ui.

This library provide for your system a swagger UI based

How to use

Install with composer:

composer require diegoborgs/natural-swagger-php

Add to your code:

use Diegoborgs\NaturalSwaggerPhp\OpenApiRenderFactory;
use Diegoborgs\NaturalSwaggerPhp\Renders\RenderOpenApi;

$render = OpenApiRenderFactory::get();
$render->render(RenderOpenApi::HTML,  ['base_path' => '/path/to/annotations']);

Contributing

Fork the project and send your PR.

Running the Tests

Install the Composer dependencies:

git clone https://github.com/eudiegoborgs/natural-swagger-php.git
cd natural-swagger-php
docker-compose run --rm composer update 
// or
composer update

Then run the test suite:

docker-compose run --rm composer test 
// or
composer test

License

This bundle is released under the MIT license.