Questions tagged [nelmioapidocbundle]

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.

118 questions
0
votes
1 answer

PHP Swagger - path at area level

How do I specify paths at the area level? Currently I have this: paths: /internal_api/token/refresh: post: tags: - Auth ... areas: default: path_patterns: -…
GrumpyHat
  • 281
  • 2
  • 15
0
votes
1 answer

Swagger annotation problems with objects containing objects

I am writing end2end tests for a rest api in a Symfony 4 project. I use php 7.4, Swagger annotation, nelmio/api-doc-bundle 3.6.1, nelmio/cors-bundle 1.5.6 This is my controller code for the method. /** * @Route(path="", name="create",…
Calamity Jane
  • 2,189
  • 5
  • 36
  • 68
0
votes
0 answers

User Notice: Required @OA\PathItem() not found : symfony 4

I m using symfony 4.4 / nelmio api doc bundle 4.0 / zircote swagger-php 3.0. When i try with a first example i get this error : User Notice: Required @OA\PathItem() not found namespace App\Controller; use OpenApi\Annotations as…
0
votes
0 answers

Nelmioapidocbundle won't work with symfony 5.0.2 ans annotations

I try to use the nelmioapidocbundle : namespace App\Controller; use App\Entity\User; use Lexik\Bundle\JWTAuthenticationBundle\Services\JWTTokenManagerInterface; use Symfony\Component\HttpFoundation\JsonResponse; use…
Altivec
  • 39
  • 1
  • 6
0
votes
1 answer

Symfony swagger add annotation for content type

I would like to add */* in my controller annotations Content-Type, I tried: * @SWG\Get(produces={"*/*","application/json"}) this doesn't work : * @SWG\Get(produces={"*\//*","application/json"}) Thanks in advance
0
votes
1 answer

Dump Documentation [NelmioApiDocBundle] v3.0

I'm using the NelmioApiDocBundle (v3.0) in my symfony 4 project and I want to dump the documentation of my Api project. I see it's possible to do with older version of NelmioApiDocBundle with this command : php bin/console api:swagger:dump…
Floran
  • 304
  • 2
  • 14
0
votes
1 answer

Rendering problem with the NelmioApiDocBundle

I have a problem with the bundle "NelmioApiDocBundle". my rendering https://localhost:8000/api/doc The rendering is raw when it should be much more design. ***routes.yaml*** api_login_check: path: /api/login_check app.swagger: …
ivan
  • 1
0
votes
1 answer

Symfony 4.2 and Nelmio Api Doc Bundle - Several documentation with multiple Controllers

I'm using Symfony 4 and Nelmio Api Doc Bundle to create a service that will be only accessible trough APIs (both public frontend and private back office will be created using a JS framework) I need 2 documentations (maybe more later)…
Julien
  • 407
  • 6
  • 16
0
votes
0 answers

How to define an associative array in Nelmio API DOC vs 3?

I am using Symfomy 3.4 with Nelmio API DOC vs 3. I have a GET API with a multiplier parameter of the format: multiplier[14]=2&multiplier[15]=1. I want to be able to make the request from /api-doc panel with the keys of the array, not only the…
George Olah
  • 577
  • 5
  • 16
0
votes
2 answers

Disabling Sandbox for NelmioApiDocs on Symfony 3.4

i want to disable the sandbox mode for NelmioApiDocs on Symfony "v3.4.11" and nelmio/api-doc-bundle "v3.2.1" I've tried: # app/config/config.yml # nelmio_api_doc nelmio_api_doc: documentation: sandbox: enabled: false After…
CasualBen
  • 829
  • 8
  • 22
0
votes
2 answers

Unrecognized option "areas" in NelmioApiDocBundle Symfony3.4

I want to build an UI documentation with swagger for my Restful API. this is the offitial documentation for that https://symfony.com/doc/master/bundles/NelmioApiDocBundle/index.html But i got this error Unrecognized option "areas" under…
0
votes
1 answer

Oauth2 Authorization in NelmioApiDocBundle

I am trying to use the NelmioApiDocBundle for a Symfony 3.4 projects API documentation, while also trying to wrap my head around OAuth 2 authorization for the project API access to begin with. So far I've followed this tutorial on how to get…
MEmerson
  • 772
  • 1
  • 6
  • 17
0
votes
1 answer

Nelmio API doc bundle post request with boolean always returns true

I'm developping a Symfony 4 API REST app with Nelmio Api Doc Bundle v3. I am sending this request : curl -X POST "http://dev.api_events.jessie/api/event-types" -H "accept: application/json" -H "Authorization: Bearer…
France Benoit
  • 121
  • 1
  • 6
0
votes
1 answer

Consolidation of annotations

Is it possible to consolidate these two annotations so that I write it in single place? use Swagger\Annotations as SWG; use FOS\RestBundle\Controller\Annotations\RequestParam; /** * @SWG\Parameter( * name="user_id", * in="query", * …
Roman Newaza
  • 11,405
  • 11
  • 58
  • 89
0
votes
1 answer

Where to put @SWG\Definition to be reused with Swagger-PHP and Nelmio API-DOC Bundle

I'd like to write a @SWG\Definition somewhere and refer to it in the @SWG\Schema in @SWG\Response annotations for multiple REST API actions in my Symfony 3 application. I'm using the dev-master version of Nelmio's api-doc-bundle but I can seem to…
Paul Dugas
  • 325
  • 2
  • 14