如何使用 NelmioApiDocBundle 为 Symfony 中的唯一区域设置 @SWG\Info 注释
How to set @SWG\Info annotation for only area in Symfony using NelmioApiDocBundle
/**
* @SWG\Swagger(
* @SWG\Info(
* title="My first swagger documented API",
* version="1.0.0"
* )
* )
*/
我试着把这个块写在:
我的基地控制器 - src/MyProject/ApiBundle/Controller/SiteApi/SiteApiBaseController.php
我的包文件 - src/MyProject/ApiBundle/MyProjectApiBundle.php
生成的 JSON 包含空 "info": {"title": ""}
Symfony 3.4、NelmioApiDocBundle 3.9.1(包括 zircote/swagger-php 2.0.9)
• 对于控制器尝试:
/**
use FOS\RestBundle\Controller\Annotations as Rest;
use Swagger\Annotations as SWG;
...
* Add Tva.
* @Rest\Post("/tva/add")
* @SWG\Tag(name="TVA Management")
...
...
* @SWG\Response(response=201, description="Tva created successfully.")
...
...
*/
=> 你会得到这样的东西:
• 对于 api/doc 页面标题、描述和版本,尝试编辑此文件:
~Your_Project_Path\config\packages\nelmio_api_doc.yaml
/**
* @SWG\Swagger(
* @SWG\Info(
* title="My first swagger documented API",
* version="1.0.0"
* )
* )
*/
我试着把这个块写在:
我的基地控制器 - src/MyProject/ApiBundle/Controller/SiteApi/SiteApiBaseController.php
我的包文件 - src/MyProject/ApiBundle/MyProjectApiBundle.php
生成的 JSON 包含空 "info": {"title": ""}
Symfony 3.4、NelmioApiDocBundle 3.9.1(包括 zircote/swagger-php 2.0.9)
• 对于控制器尝试:
/**
use FOS\RestBundle\Controller\Annotations as Rest;
use Swagger\Annotations as SWG;
...
* Add Tva.
* @Rest\Post("/tva/add")
* @SWG\Tag(name="TVA Management")
...
...
* @SWG\Response(response=201, description="Tva created successfully.")
...
...
*/
=> 你会得到这样的东西:
• 对于 api/doc 页面标题、描述和版本,尝试编辑此文件:
~Your_Project_Path\config\packages\nelmio_api_doc.yaml