RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-09 02:59:27 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #2011 from magnetik/interfaces

Browse Source 
The ObjectModelDescriber can support interfaces
This commit is contained in:
Guilhem Niot 2022-08-29 23:00:08 +02:00 committed by GitHub
commit 27ed1cc28e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
ModelDescriber/ObjectModelDescriber.php
View File

@ -215,6 +215,7 @@ class ObjectModelDescriber implements ModelDescriberInterface, ModelRegistryAwar
public function supports(Model $model): bool
{
return Type::BUILTIN_TYPE_OBJECT === $model->getType()->getBuiltinType() && class_exists($model->getType()->getClassName());
return Type::BUILTIN_TYPE_OBJECT === $model->getType()->getBuiltinType()
&& (class_exists($model->getType()->getClassName()) || interface_exists($model->getType()->getClassName()));
}
}

18
Tests/Functional/Controller/ApiController80.php
View File

@ -11,6 +11,7 @@
namespace Nelmio\ApiDocBundle\Tests\Functional\Controller;
use Functional\Entity\ArticleInterface;
use Nelmio\ApiDocBundle\Annotation\Areas;
use Nelmio\ApiDocBundle\Annotation\Model;
use Nelmio\ApiDocBundle\Annotation\Operation;
@ -51,6 +52,23 @@ class ApiController80
{
}
/**
* @OA\Get(
* @OA\Response(
* response="200",
* description="Success",
* @Model(type=ArticleInterface::class, groups={"light"}))
* )
* )
* @OA\Parameter(ref="#/components/parameters/test")
* @Route("/article-interface/{id}", methods={"GET"})
* @OA\Parameter(name="Accept-Version", in="header", @OA\Schema(type="string"))
* @OA\Parameter(name="Application-Name", in="header", @OA\Schema(type="string"))
*/
public function fetchArticleInterfaceAction()
{
}
/**
* The method LINK is not supported by OpenAPI so the method will be ignored.
*

8
Tests/Functional/Entity/ArticleInterface.php Normal file
View File

@ -0,0 +1,8 @@
<?php
namespace Functional\Entity;
interface ArticleInterface
{
public function getAuthor(): string;
}