nelmioapidocbundle

set Nelmio ApiDoc return parameter description

由 拈花ヽ惹草 提交于 2021-02-19 07:16:25
问题 On the ApiDoc for our controller we have specified the output response object and now we see a list of all the parameters that get returned. How do we provide values for the version and/or description fields on this list? I have tried adding @ApiDoc(description="text") to the response object's parameters but that doesn't seem to be doing anything. Thanks in advance. 回答1: I stepped through the ApiDocBundle today and see that Description comes from the comment on the model property or method

nelmio api doc bundle not render input type

由 和自甴很熟 提交于 2019-12-13 07:37:06
问题 Im using Nelmio API Doc Bundle to expose my api documentation. I use it with base configuration. Also using Symfony 3.1. But on controller even when i define the input parameter inside ApiDoc annotation the documentation does not show the input. * @ApiDoc( * section="Customer", * description="Request reset password", * input="AppBundle\Form\ResendConfirmationEmailType", * statusCodes={ * 200="Returned when successful", * 500="Returned on not found Customer" * }, * tags={ * "beta" = "#4A7023",

Symfony NelmioApiDocBundle swagger-ui PHP Annotations json object with array of objects properties not showing

由 别等时光非礼了梦想. 提交于 2019-12-10 16:48:26
问题 I'm trying to post json with NelmioApiDocBundle, I have the json example showing up but the array object properties are not showing in the try it out example? I have tried several methods to accomplish this without success, Below is the code I have tried. Any help greatly appreciated. when I try to add the example for the items it puts quotes around the array so its not valid json and I have to escape the quotes so it adds slashes not what I want Here is the Json trying to post in body '{

Symfony, nelmio/api-doc-bundle and @SWG\SecurityScheme

由 倾然丶 夕夏残阳落幕 提交于 2019-12-09 23:43:43
问题 I'm trying to document my Symfony 3.4 application API using nelmio/api-doc-bundle but fail to create a security scheme. Generating the documentation itself works as expected with the following configuration: nelmio_api_doc: documentation: info: description: FooBar API title: FooBar version: 1.0.0 routes: path_patterns: - ^/api/ And the following annotations: /** * @SWG\Get( * security={ * {"ApiKeyAuth":{}} * }, * @SWG\Response( * response=200, * description="Returns all [Foo]", * @SWG\Schema(

Symfony, nelmio/api-doc-bundle and @SWG\\SecurityScheme

由 不问归期 提交于 2019-12-04 19:22:14
I'm trying to document my Symfony 3.4 application API using nelmio/api-doc-bundle but fail to create a security scheme. Generating the documentation itself works as expected with the following configuration: nelmio_api_doc: documentation: info: description: FooBar API title: FooBar version: 1.0.0 routes: path_patterns: - ^/api/ And the following annotations: /** * @SWG\Get( * security={ * {"ApiKeyAuth":{}} * }, * @SWG\Response( * response=200, * description="Returns all [Foo]", * @SWG\Schema( * type="array", * @Model(type=App\Entity\Foo::class) * ) * ), * @SWG\Response( * response=404, *
订阅 nelmioapidocbundle