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
2
votes
2 answers
NelmioApiDoc - Hide documentation section by default
By default, ApiDoc lists out all operations for each API endpoint, like this:
In the Swagger demo, however, operations are hidden by default until the user chooses to show them.
Is there a configuration option for ApiDoc that will hide operations…
Lukas Hajdu
- 806
- 7
- 18
2
votes
0 answers
Nelmio API doc: Documentation says my json objects are arrays, how to fix?
I'm using Nelmio API docs to generate the documentation for my REST api using FOSRestBundle and JMSSerializer. The docs generated say my json objects are actually arrays. How do I make the documentation say my objects are objects?
I know under the…
James
- 197
- 2
- 13
2
votes
0 answers
NelmioApiDocBundle generates extra inputs when using FormType with nested forms
I'm using to use NelmioApiDocBundle to generate API documentation. The problem is when I use FormType with nested forms or buttons (submit /cancel), I get extra parameters. This is my FormType:
class RegistrationFormType extends…
Bilel Noômene
- 98
- 6
2
votes
1 answer
How to remove _format URL suffix from documentation generated by NelmioApiDocBundle?
I've installed the NelmioApiDocBundle for my new API-oriented project in Symfony and I can't get rid of the .{_format} suffix that this bundle adds to all my endpoint URLs.
This is how it looks:
My API does not support the _format as suffix. It…
Najki
- 514
- 6
- 22
2
votes
0 answers
NelmioApiDocBundle can´t parser mongoDB Document
I use NelmioApiDocBundle for documentation of my API-Rest. If I use entity class, documentation (Input and Output) is created correctly. Nevertheless, Nelmio isn´t creating documentation for Document class of MongoDB :(
Any ideas?
Yonedev
- 636
- 4
- 15
2
votes
1 answer
Add oauth2 support in nelmio sandboxes
I'm working on a REST API in Symfony2 (created with FosRestBundle).
Before oauth was enabled I could try the API methods in the sandbox provided by nelmio.
Example:
GET /api/products/{id}.json
However now that oauth is enabled in order to call an…
rfc1484
- 9,441
- 16
- 72
- 123
2
votes
0 answers
Override @param doc on nelmio api doc
I have a REST controller using the ParamConverter Symfony's service, using nelmio api doc annotation :
Soullivaneuh
- 3,553
- 3
- 37
- 71
1
vote
0 answers
Symfony 6.3.0 Endpoint not showing up in nelmio api interface
I have a problem with displaying my endpoints in the nelmio api interface. this is my config:
nelmio_api_doc.yaml
nelmio_api_doc:
areas:
path_patterns: # an array of regexps
- ^/api(?!/doc$)
host_patterns:
-…
Micheal841
- 11
- 3
1
vote
0 answers
How can I force not to show prefix for Symfony nelmio-api-doc bundle
I need to hide an /rpc prefix on swagger table for some methods which are going to be used for json-rpc requests:
Which is placed from a config file nelmio_api_doc.yaml
Any suggestions are welcome! Maybe anyone knows an option like hide_prefix:…
Alex Gore
- 332
- 1
- 3
- 9
1
vote
1 answer
Symfony - Open API 3 - Set JSON response as example in controlller
Im using Open Api 3 (exactly NelmioApiDocBundle) in Symfony to document APIs and I have the following code:
* @Route("/login", name="user_login", methods={"POST"})
*
* @OA\Response(
* response=200,
* @OA\JsonContent(
* type="object",
* …
m4n50n1k0
- 11
- 3
1
vote
1 answer
OpenApi/NelmioAPiDoc: How to add a parameter for every defined route?
I have a header param which should be used for every route. But I don't want to add the annotation for this param in every Controller.
I tried different things but it's not possible to add it to an interface or to a class which will be exteneded by…
Zwen2012
- 3,360
- 9
- 40
- 67
1
vote
1 answer
PHP Symfony NelmioApiDocBundle ignore methods in model class
I created the following class (simplified for the example) and using as @Model.
class Model
{
public string $name;
public function address(): string
{
return "$this->name@gmail.com";
}
public function isShort(): bool
…
Gianni Genovesi
- 91
- 6
1
vote
0 answers
Entity attributes not displayed in payload request and response payload NelmioApiDoc bundle
I am unable to display the payload of the request and the response according to the serialization groups defined with JmsSerialiazer-bundle as shown in this screenshot :
I want to display the fields of campaignDeserializer group in a json example…
hamouda4291
- 31
- 1
- 2
1
vote
3 answers
Symfony NelmioAPIDocBundle: Remove Logo Header?
Is it possible to remove the logo header shown in the web-based output of NelmioApiDocBundle? And if so, how?
I would like to include the output of this endpoint (/api/doc if you're using the default settings) in an existing website. However, that…
jetsetter
- 517
- 5
- 19
1
vote
1 answer
NelmioApiDocBundle says a Describer doesn't exist for a class
I created a symfony app for testing purposes and imported the NelmioApiDoc bundle.
I tried implementing almost identical logic and structure as Symfony demonstrates in their documentation here…
yukitmp
- 15
- 3