mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-09 02:59:27 +03:00
6f85aed33c
Unified data types [actualType and subType]
Updated tests.
JMS parsing fixes; updated {Validator,FormType}Parser, FOSRestHandler, and AbstractFormatter, and updated DataTypes enum.
Modified dataType checking.
Updated tests.
Updated DataTypes enum.
Quick fix and added doc comments.
CS fixes.
Refactored FormTypeParser to produce nested parameters. Updated tests accordingly.
Logical and CS fixes.
Sub-forms and more tests.
Logical and CS fixes.
Swagger support: created formatter.
Configuration and resourcePath logic update.
ApiDoc annotation update. Updated formatter and added tests.
Parameter formatting.
Added tests for SwaggerFormatter.
Added option in annotation, and the corresponding logic for parsing the supplied values and processing them in the formatter.
Routing update.
Updated tests.
Removed unused dependency and updated doc comments.
Renamed 'responseModels' to 'responseMap'
Update the resource filtering and formatting of response messages.
Updated check for 200 response model.
Ignore data_class and always use form-type to avoid conflicts.
Fix: add 'type' even if '' is specified.
Refactored responseMap; added parsedResponseMap. Added tests and updated some.
Fix: add 'type' even if '' is specified.
Initial commit of command.
Finished logic for dumping files.
Updated doc comment; added license and added more meaningful class comment.
Array of models support.
726 lines
37 KiB
PHP
726 lines
37 KiB
PHP
<?php
|
|
|
|
namespace Nelmio\ApiDocBundle\Tests\Formatter;
|
|
|
|
|
|
use Nelmio\ApiDocBundle\Extractor\ApiDocExtractor;
|
|
use Nelmio\ApiDocBundle\Formatter\SwaggerFormatter;
|
|
use Nelmio\ApiDocBundle\Tests\WebTestCase;
|
|
|
|
|
|
/**
|
|
* Class SwaggerFormatterTest
|
|
*
|
|
* @package Nelmio\ApiDocBundle\Tests\Formatter
|
|
* @author Bez Hermoso <bez@activelamp.com>
|
|
*/
|
|
class SwaggerFormatterTest extends WebTestCase
|
|
{
|
|
/**
|
|
* @var ApiDocExtractor
|
|
*/
|
|
protected $extractor;
|
|
|
|
/**
|
|
* @var SwaggerFormatter
|
|
*/
|
|
protected $formatter;
|
|
|
|
protected function setUp()
|
|
{
|
|
parent::setUp();
|
|
|
|
$container = $this->getContainer();
|
|
$this->extractor = $container->get('nelmio_api_doc.extractor.api_doc_extractor');
|
|
$this->formatter = $container->get('nelmio_api_doc.formatter.swagger_formatter');
|
|
}
|
|
|
|
|
|
public function testResourceListing()
|
|
{
|
|
|
|
set_error_handler(array($this, 'handleDeprecation'));
|
|
$data = $this->extractor->all();
|
|
restore_error_handler();
|
|
|
|
/** @var $formatter SwaggerFormatter */
|
|
|
|
$actual = $this->formatter->format($data, null);
|
|
|
|
|
|
$expected = array(
|
|
'swaggerVersion' => '1.2',
|
|
'apiVersion' => '3.14',
|
|
'info' =>
|
|
array(
|
|
'title' => 'Nelmio Swagger',
|
|
'description' => 'Testing Swagger integration.',
|
|
'TermsOfServiceUrl' => 'https://github.com',
|
|
'contact' => 'user@domain.tld',
|
|
'license' => 'MIT',
|
|
'licenseUrl' => 'http://opensource.org/licenses/MIT',
|
|
),
|
|
'authorizations' =>
|
|
array(),
|
|
'apis' =>
|
|
array(
|
|
array(
|
|
'path' => '/other-resources',
|
|
'description' => 'Operations on another resource.',
|
|
),
|
|
array(
|
|
'path' => '/resources',
|
|
'description' => 'Operations on resource.',
|
|
),
|
|
array(
|
|
'path' => '/tests',
|
|
'description' => NULL,
|
|
),
|
|
array(
|
|
'path' => '/tests',
|
|
'description' => NULL,
|
|
),
|
|
array(
|
|
'path' => '/tests2',
|
|
'description' => NULL,
|
|
),
|
|
array(
|
|
'path' => '/TestResource',
|
|
'description' => NULL,
|
|
),
|
|
),
|
|
);
|
|
|
|
$this->assertEquals($expected, $actual);
|
|
|
|
|
|
}
|
|
|
|
/**
|
|
* @dataProvider dataTestApiDeclaration
|
|
*/
|
|
public function testApiDeclaration($resource, $expected)
|
|
{
|
|
set_error_handler(array($this, 'handleDeprecation'));
|
|
$data = $this->extractor->all();
|
|
restore_error_handler();
|
|
|
|
$actual = $this->formatter->format($data, $resource);
|
|
|
|
$this->assertEquals($expected, $actual);
|
|
|
|
}
|
|
|
|
public function dataTestApiDeclaration()
|
|
{
|
|
return array(
|
|
array(
|
|
'/resources',
|
|
array(
|
|
'swaggerVersion' => '1.2',
|
|
'apiVersion' => '3.14',
|
|
'basePath' => '/api',
|
|
'resourcePath' => '/resources',
|
|
'apis' =>
|
|
array(
|
|
|
|
array(
|
|
'path' => '/resources.{_format}',
|
|
'operations' =>
|
|
array(
|
|
array(
|
|
'method' => 'GET',
|
|
'summary' => 'List resources.',
|
|
'nickname' => 'get_resources',
|
|
'parameters' =>
|
|
array(
|
|
|
|
array(
|
|
'paramType' => 'path',
|
|
'name' => '_format',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
'enum' =>
|
|
array(
|
|
'json',
|
|
'xml',
|
|
'html',
|
|
),
|
|
),
|
|
),
|
|
'responseMessages' =>
|
|
array(
|
|
|
|
array(
|
|
'code' => 200,
|
|
'message' => 'Returned on success.',
|
|
),
|
|
|
|
array(
|
|
'code' => 404,
|
|
'message' => 'Returned if resource cannot be found.',
|
|
),
|
|
),
|
|
),
|
|
|
|
array(
|
|
'method' => 'POST',
|
|
'summary' => 'Create a new resource.',
|
|
'nickname' => 'post_resources',
|
|
'parameters' =>
|
|
array(
|
|
|
|
array(
|
|
'paramType' => 'path',
|
|
'name' => '_format',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
'enum' =>
|
|
array(
|
|
'json',
|
|
'xml',
|
|
'html',
|
|
),
|
|
),
|
|
|
|
array(
|
|
'paramType' => 'form',
|
|
'name' => 'a',
|
|
'type' => 'string',
|
|
),
|
|
|
|
array(
|
|
'paramType' => 'form',
|
|
'name' => 'b',
|
|
'type' => 'number',
|
|
'format' => 'float',
|
|
),
|
|
|
|
array(
|
|
'paramType' => 'form',
|
|
'name' => 'c',
|
|
'type' => 'string',
|
|
'enum' =>
|
|
array(
|
|
'x',
|
|
'y',
|
|
'z',
|
|
),
|
|
),
|
|
|
|
array(
|
|
'paramType' => 'form',
|
|
'name' => 'd',
|
|
'type' => 'string',
|
|
'format' => 'date-time',
|
|
),
|
|
|
|
array(
|
|
'paramType' => 'form',
|
|
'name' => 'e',
|
|
'type' => 'string',
|
|
'format' => 'date',
|
|
),
|
|
|
|
array(
|
|
'paramType' => 'form',
|
|
'name' => 'g',
|
|
'type' => 'string',
|
|
),
|
|
),
|
|
'responseMessages' =>
|
|
array(
|
|
|
|
array(
|
|
'code' => 200,
|
|
'message' => 'See standard HTTP status code reason for 200',
|
|
'responseModel' => 'Nelmio.ApiDocBundle.Tests.Fixtures.Model.JmsNested',
|
|
),
|
|
),
|
|
),
|
|
),
|
|
),
|
|
|
|
array(
|
|
'path' => '/resources/{id}.{_format}',
|
|
'operations' =>
|
|
array(
|
|
|
|
array(
|
|
'method' => 'GET',
|
|
'summary' => 'Retrieve a resource by ID.',
|
|
'nickname' => 'get_resources',
|
|
'parameters' =>
|
|
array(
|
|
|
|
array(
|
|
'paramType' => 'path',
|
|
'name' => 'id',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
),
|
|
|
|
array(
|
|
'paramType' => 'path',
|
|
'name' => '_format',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
'enum' =>
|
|
array(
|
|
'json',
|
|
'xml',
|
|
'html',
|
|
),
|
|
),
|
|
),
|
|
'responseMessages' =>
|
|
array(),
|
|
),
|
|
|
|
array(
|
|
'method' => 'DELETE',
|
|
'summary' => 'Delete a resource by ID.',
|
|
'nickname' => 'delete_resources',
|
|
'parameters' =>
|
|
array(
|
|
|
|
array(
|
|
'paramType' => 'path',
|
|
'name' => 'id',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
),
|
|
|
|
array(
|
|
'paramType' => 'path',
|
|
'name' => '_format',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
'enum' =>
|
|
array(
|
|
'json',
|
|
'xml',
|
|
'html',
|
|
),
|
|
),
|
|
),
|
|
'responseMessages' =>
|
|
array(),
|
|
),
|
|
),
|
|
),
|
|
),
|
|
'models' =>
|
|
array(
|
|
'Nelmio.ApiDocBundle.Tests.Fixtures.Model.JmsTest' =>
|
|
array(
|
|
'id' => 'Nelmio.ApiDocBundle.Tests.Fixtures.Model.JmsTest',
|
|
'description' => 'object (JmsTest)',
|
|
'properties' =>
|
|
array(
|
|
'foo' =>
|
|
array(
|
|
'type' => 'string',
|
|
'description' => 'string',
|
|
),
|
|
'bar' =>
|
|
array(
|
|
'type' => 'string',
|
|
'description' => 'DateTime',
|
|
'format' => 'date-time',
|
|
),
|
|
'number' =>
|
|
array(
|
|
'type' => 'number',
|
|
'description' => 'double',
|
|
'format' => 'float',
|
|
),
|
|
'arr' =>
|
|
array(
|
|
'type' => 'array',
|
|
'description' => 'array',
|
|
'items' => array(
|
|
'type' => 'string',
|
|
)
|
|
),
|
|
'nested' =>
|
|
array(
|
|
'$ref' => 'Nelmio.ApiDocBundle.Tests.Fixtures.Model.JmsNested',
|
|
),
|
|
'nested_array' =>
|
|
array(
|
|
'type' => 'array',
|
|
'description' => 'array of objects (JmsNested)',
|
|
'items' => array(
|
|
'$ref' => 'Nelmio.ApiDocBundle.Tests.Fixtures.Model.JmsNested',
|
|
)
|
|
),
|
|
),
|
|
'required' =>
|
|
array(),
|
|
),
|
|
'Nelmio.ApiDocBundle.Tests.Fixtures.Model.JmsNested' =>
|
|
array(
|
|
'id' => 'Nelmio.ApiDocBundle.Tests.Fixtures.Model.JmsNested',
|
|
'description' => '',
|
|
'properties' =>
|
|
array(
|
|
'foo' =>
|
|
array(
|
|
'type' => 'string',
|
|
'description' => 'DateTime',
|
|
'format' => 'date-time',
|
|
),
|
|
'bar' =>
|
|
array(
|
|
'type' => 'string',
|
|
'description' => 'string',
|
|
),
|
|
'baz' =>
|
|
array(
|
|
'type' => 'array',
|
|
'description' => 'Epic description.
|
|
|
|
With multiple lines.',
|
|
'items' => array(
|
|
'type' => 'string',
|
|
)
|
|
),
|
|
'circular' =>
|
|
array(
|
|
'$ref' => 'Nelmio.ApiDocBundle.Tests.Fixtures.Model.JmsNested',
|
|
),
|
|
'parent' =>
|
|
array(
|
|
'$ref' => 'Nelmio.ApiDocBundle.Tests.Fixtures.Model.JmsTest',
|
|
),
|
|
'since' =>
|
|
array(
|
|
'type' => 'string',
|
|
'description' => 'string',
|
|
),
|
|
'until' =>
|
|
array(
|
|
'type' => 'string',
|
|
'description' => 'string',
|
|
),
|
|
'since_and_until' =>
|
|
array(
|
|
'type' => 'string',
|
|
'description' => 'string',
|
|
),
|
|
),
|
|
'required' =>
|
|
array(),
|
|
),
|
|
),
|
|
'produces' =>
|
|
array(),
|
|
'consumes' =>
|
|
array(),
|
|
'authorizations' =>
|
|
array(),
|
|
),
|
|
),
|
|
array(
|
|
'/other-resources',
|
|
array(
|
|
'swaggerVersion' => '1.2',
|
|
'apiVersion' => '3.14',
|
|
'basePath' => '/api',
|
|
'resourcePath' => '/other-resources',
|
|
'apis' =>
|
|
array(
|
|
|
|
array(
|
|
'path' => '/other-resources.{_format}',
|
|
'operations' =>
|
|
array(
|
|
|
|
array(
|
|
'method' => 'GET',
|
|
'summary' => 'List another resource.',
|
|
'nickname' => 'get_other-resources',
|
|
'parameters' =>
|
|
array(
|
|
|
|
array(
|
|
'paramType' => 'path',
|
|
'name' => '_format',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
'enum' =>
|
|
array(
|
|
'json',
|
|
'xml',
|
|
'html',
|
|
),
|
|
),
|
|
),
|
|
'responseMessages' =>
|
|
array(),
|
|
),
|
|
),
|
|
),
|
|
|
|
array(
|
|
'path' => '/other-resources/{id}.{_format}',
|
|
'operations' =>
|
|
array(
|
|
|
|
array(
|
|
'method' => 'PUT',
|
|
'summary' => 'Update a resource bu ID.',
|
|
'nickname' => 'put_other-resources',
|
|
'parameters' =>
|
|
array(
|
|
|
|
array(
|
|
'paramType' => 'path',
|
|
'name' => 'id',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
),
|
|
|
|
array(
|
|
'paramType' => 'path',
|
|
'name' => '_format',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
'enum' =>
|
|
array(
|
|
'json',
|
|
'xml',
|
|
'html',
|
|
),
|
|
),
|
|
),
|
|
'responseMessages' =>
|
|
array(),
|
|
),
|
|
|
|
array(
|
|
'method' => 'PATCH',
|
|
'summary' => 'Update a resource bu ID.',
|
|
'nickname' => 'patch_other-resources',
|
|
'parameters' =>
|
|
array(
|
|
|
|
array(
|
|
'paramType' => 'path',
|
|
'name' => 'id',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
),
|
|
|
|
array(
|
|
'paramType' => 'path',
|
|
'name' => '_format',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
'enum' =>
|
|
array(
|
|
'json',
|
|
'xml',
|
|
'html',
|
|
),
|
|
),
|
|
),
|
|
'responseMessages' =>
|
|
array(),
|
|
),
|
|
),
|
|
),
|
|
),
|
|
'models' =>
|
|
array(),
|
|
'produces' =>
|
|
array(),
|
|
'consumes' =>
|
|
array(),
|
|
'authorizations' =>
|
|
array(),
|
|
),
|
|
),
|
|
array(
|
|
'/tests',
|
|
array (
|
|
'swaggerVersion' => '1.2',
|
|
'apiVersion' => '3.14',
|
|
'basePath' => '/api',
|
|
'resourcePath' => '/tests',
|
|
'apis' =>
|
|
array (
|
|
|
|
array (
|
|
'path' => '/tests.{_format}',
|
|
'operations' =>
|
|
array (
|
|
|
|
array (
|
|
'method' => 'GET',
|
|
'summary' => 'index action',
|
|
'nickname' => 'get_tests',
|
|
'parameters' =>
|
|
array (
|
|
|
|
array (
|
|
'paramType' => 'path',
|
|
'name' => '_format',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
),
|
|
),
|
|
'responseMessages' =>
|
|
array (
|
|
),
|
|
),
|
|
|
|
array (
|
|
'method' => 'GET',
|
|
'summary' => 'index action',
|
|
'nickname' => 'get_tests',
|
|
'parameters' =>
|
|
array (
|
|
|
|
array (
|
|
'paramType' => 'path',
|
|
'name' => '_format',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
),
|
|
|
|
array (
|
|
'paramType' => 'query',
|
|
'name' => 'a',
|
|
'type' => 'integer',
|
|
),
|
|
|
|
array (
|
|
'paramType' => 'query',
|
|
'name' => 'b',
|
|
'type' => 'string',
|
|
),
|
|
),
|
|
'responseMessages' =>
|
|
array (
|
|
),
|
|
),
|
|
|
|
array (
|
|
'method' => 'POST',
|
|
'summary' => 'create test',
|
|
'nickname' => 'post_tests',
|
|
'parameters' =>
|
|
array (
|
|
|
|
array (
|
|
'paramType' => 'path',
|
|
'name' => '_format',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
),
|
|
|
|
array (
|
|
'paramType' => 'query',
|
|
'name' => 'a',
|
|
'type' => 'integer',
|
|
),
|
|
|
|
array (
|
|
'paramType' => 'query',
|
|
'name' => 'b',
|
|
'type' => 'string',
|
|
),
|
|
|
|
array (
|
|
'paramType' => 'form',
|
|
'name' => 'a',
|
|
'type' => 'string',
|
|
),
|
|
|
|
array (
|
|
'paramType' => 'form',
|
|
'name' => 'b',
|
|
'type' => 'string',
|
|
),
|
|
|
|
array (
|
|
'paramType' => 'form',
|
|
'name' => 'c',
|
|
'type' => 'boolean',
|
|
),
|
|
|
|
array (
|
|
'paramType' => 'form',
|
|
'name' => 'd',
|
|
'type' => 'string',
|
|
),
|
|
),
|
|
'responseMessages' =>
|
|
array (
|
|
),
|
|
),
|
|
|
|
array (
|
|
'method' => 'POST',
|
|
'summary' => 'create test',
|
|
'nickname' => 'post_tests',
|
|
'parameters' =>
|
|
array (
|
|
|
|
array (
|
|
'paramType' => 'path',
|
|
'name' => '_format',
|
|
'type' => 'string',
|
|
'required' => true,
|
|
),
|
|
|
|
array (
|
|
'paramType' => 'form',
|
|
'name' => 'a',
|
|
'type' => 'string',
|
|
),
|
|
|
|
array (
|
|
'paramType' => 'form',
|
|
'name' => 'b',
|
|
'type' => 'string',
|
|
),
|
|
|
|
array (
|
|
'paramType' => 'form',
|
|
'name' => 'c',
|
|
'type' => 'boolean',
|
|
),
|
|
|
|
array (
|
|
'paramType' => 'form',
|
|
'name' => 'd',
|
|
'type' => 'string',
|
|
),
|
|
),
|
|
'responseMessages' =>
|
|
array (
|
|
),
|
|
),
|
|
),
|
|
),
|
|
),
|
|
'models' =>
|
|
array (
|
|
),
|
|
'produces' =>
|
|
array (
|
|
),
|
|
'consumes' =>
|
|
array (
|
|
),
|
|
'authorizations' =>
|
|
array (
|
|
),
|
|
),
|
|
),
|
|
);
|
|
}
|
|
} |