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

Delete UPGRADING-3.0.md

Browse source
This commit is contained in:
Guilhem Niot 2017-05-13 18:11:43 +02:00 • committed by GitHub
parent 8d5a0aff01
commit ab765b05dd
1 changed files with 0 additions and 58 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
UPGRADING-3.0.md
View file

@ -1,58 +0,0 @@
# Upgrading From 2.x To 3.0
NelmioApiDocBundle has been entirely refactored in 3.0 to focus on Swagger
and most of it has changed.
## Upgrade Your Annotations
The `@ApiDoc` annotation has been removed and you must now use
[Swagger-php](https://github.com/zircote/swagger-php) annotations.
An upgrade example:
```php
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
class YourController extends Controller
{
/**
* This is a description of your API method.
*
* @ApiDoc(
* filters={
* {"name"="a-filter", "dataType"="integer"},
* {"name"="another-filter", "dataType"="string", "pattern"="(foo|bar) ASC|DESC"}
* }
* )
*/
public function getAction()
{
}
}
```
will become:
```php
use Swagger\Annotations as SWG;
class YourController extends Controller
{
/**
* This is a description of your API method.
*
* @SWG\Parameter(
* name="a-filter",
* in="query",
* type="integer"
* )
* @SWG\Parameter(
* name="another-filter",
* in="query",
* type="string",
* format="(foo|bar) ASC|DESC"
* )
*/
public function getAction()
{
}
}
```