The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.
The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs. More information on the github page.
Questions tagged [nelmioapidocbundle]
118 questions
1
vote
1 answer
Symfony jmsserilaizerbundle configuration not working
I want to create my own restful API using symfony php framework.
of cause, i use
- FOSRestBundle
- FOSUserBundle
- LexikJWTAuthenticationBundle
- JMSSerializerBundle
After the configuration of all bundles my API return empty…
Camerev
- 167
- 1
- 11
1
vote
1 answer
How to add swagger's security annotation to fos rest controller?
Good day,
I have a Symfony API project with FOSRestBundle and NelmioApiDocBundle.
I dont know how to add a security annotation with FOS Rest.
I am using OAuth v2 so my security is based on the following:
apiKey: accessToken, refreshToken.
This is…
alytvynov
- 81
- 12
1
vote
0 answers
Does nelmioApiDocBundle support symfony serializer normalizers and name converters?
I'm working on a Symfony 3.4 API. I want to generate documentation for the API using nelmioApiDocBundle v3.2 but I'm facing some obstacles. For serialization and normalization I use Symfony serializer but I can't make nelmioApiDocBundle use the…
PPink
- 11
- 2
1
vote
0 answers
NelmioApiDocBundle: generate documentation in build pipeline
In a project built using Symfony 4, we use NelmioApiDocBundle version 3 plus Swagger annotations, which works fine.
In addition to browsing the API docs, I would like to create a static version of the documentation, to be generated in a build…
BlueM
- 3,658
- 21
- 34
1
vote
1 answer
Object within Object Swagger
I'm using NelmioApiDocBundle and Swagger to describe my API.
I want to describe my response object that contains another object:
For example - json str:
"Person": {
"firstname": "John",
"lastName": "Smith",
"car": {
"brand":…
Joozty
- 460
- 2
- 12
- 40
1
vote
1 answer
NelmioApiDoc v3 / Swagger - multiple API docs
NelmioApiDoc v2 allowed to use multiple views parameter so I can hide some endpoints and present them on different URL
https://symfony.com/doc/current/bundles/NelmioApiDocBundle/multiple-api-doc.html
Is it possible to do it in NelmioApiDoc v3 which…
breq
- 24,412
- 26
- 65
- 106
1
vote
1 answer
Symfony, nelmio/api-doc-bundle and @SWG\SecurityScheme
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:
…
conceptdeluxe
- 3,753
- 3
- 25
- 29
1
vote
1 answer
Symfony FOSREST API Datetime Error
I'm using symfony 2.7, I have created the API, When I submit the form(json data) using postman, It is not accepting datetime value.
Form Builder
->add('letAt','datetime')
Command
/**
* @var DateTime
* @Assert\NotNull(message="Please…
Aamir
- 2,173
- 1
- 29
- 58
1
vote
1 answer
Symfony: Output example image in nelmio api docs?
I am using the Nelmio Api Doc to generate documentation for my API. I have just added a new endpoint which returns image/png files based on an id parameter. How am I best representing this response in my api docs? I would ideally like to display an…
Freid001
- 2,580
- 3
- 29
- 60
1
vote
1 answer
Swagger-UI Symfony NelmioAPiDoc add multiple responseType options
I am looking for a way to add multiple response types to swagger-ui implemented through NelmioAPiDoc
I would like the option for image/jpeg as a response type I have the code to work in the controller to set the body to the image even if the…
user1930591
- 307
- 5
- 22
1
vote
1 answer
Why does a custom route appears twice in Nelmio API Doc?
I've tried defining a custom route name for one of my APIs and since then, the API Doc displays that route twice. Any ideas why?
Here's the definition of my API:
/**
* @ApiDoc(
* description = "Sends the support email to the HelpDesk address",
…
Sebastian
- 250
- 1
- 13
1
vote
1 answer
Parameter tags value '' violated a constraint (Expected argument of type \"array or Traversable\", \"string\" given)"
please i need your help, i'm trying to insert an image using nelmio bundle but it gives me this error Parameter tags value '' violated a constraint (Expected argument of type \"array or Traversable\", \"string\" given)"
my controller is as follows
…
anony
- 185
- 2
- 14
1
vote
2 answers
How do I include a query parameter in a POST request using NelmioApiDocBundle?
I'm using (and new to) Symfony 3 and NelmioApiDocbundle. I want to handle a POST request that has optional query parameters. The url would be something like:
http://example.com/api/updateusers?token=some_long_value
This is what I've tried for my…
sTony
- 11
- 3
1
vote
2 answers
Circular reference detected in routing_dev.yml
I'm getting crazy with this circular reference issue and I can't find what I'm doing wrong. This is the content of /app/config/routing.yml:
pd_one:
resource: "@PDOneBundle/Controller/"
type: annotation
prefix: /
template:
…
ReynierPM
- 17,594
- 53
- 193
- 363
0
votes
0 answers
How to render a hashmap with OpenAPI 3.1 and Nelmio?
I would like to correctly render a hashmap (key: a UUID, value: an object) both in the Response schema AND the Response samples (examples) sections of my API doc such:
{
"objects": {
"3a34655e-9566-4d5e-bce7-8fa71670993b": {
"title":…
Bouss
- 3
- 4