Styjun

How do I explain that I don't want to maintain old projects?

Four ships at the ocean with the same distance

Did depressed people far more accurately estimate how many monsters they killed in a video game?

What do you call a situation where you have choices but no good choice?

Where are the Wazirs?

Moving millions of files to a different directory with specfic name patterns

As a supervisor, what feedback would you expect from a PhD who quits?

Is it okay to use open source code to do an interview task?

is there a real life meaning about KMeans error?

Why do the Duga-1 dipoles look like an array of birdcages?

What exactly is a "murder hobo"?

Strong Password Detection in Python

This LM317 diagram doesn't make any sense to me

How to use Adostop Eco stop bath?

What does "spinning upon the shoals" mean?

How to evaluate the performance of open source solver?

Tikz, arrow formatting

Users forgotting to regenerate PDF before sending it

Where are all the non-aquatic mouthbrooders?

stuck in/at beta

Why does Trump want a citizenship question on the census?

Writing an ace/aro character?

Is space division multiplexing really multiplexing?

Deck of Cards with Shuffle and Sort functionality

Symfony 4 NelmioApiDocBundle security headers not set

NelmioApiDocBundle, require header for all requests and return custom objectHow do I include a query parameter in a POST request using NelmioApiDocBundle?NelmioApiDocBundle Post Request with Json bodyNelmioApiDocBundle Support for swagger 2.0Symfony2: Why is the view annotation in NelmioApiDocBundle not working?Symfony Flex: What does symfony.lock file do?NelmioApiDocBundle: generate documentation in build pipelineImpossible connexion to admin panel with Symfony 4 / SecurityDoes nelmioApiDocBundle support symfony serializer normalizers and name converters?NelmioApiDocBundle not generate documentation

.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty margin-bottom:0;

1

I'm using Symfony 4 and the NelmioApiDocBundle for an API.

I have the bundle setup and working but I'm trying to require an apiKey header in all endpoints by default.

I've followed the documentation but I cannot see a header of TEST-KEY when I run try it out in my /api/docs - what am I doing wrong?

nelmio_api_doc.yml

nelmio_api_doc:
 documentation:
 info:
 title: Test API
 description: Test API
 version: 1.0.0
 securityDefinitions:
 apiKey:
 type: apiKey
 description: 'My test authentication key'
 name: TEST-KEY
 in: header
 security:
 - apiKey: []
 areas:
 path_patterns:
 - ^/api(?!/doc$)

AppControllerTestController.php

 /**
 * @Operation(
 * tags="Test API",
 * produces="application/json",
 * summary="Get a list of all...",
 * @SWGParameter(
 * name="start",
 * in="query",
 * description="Offset...",
 * required=false,
 * type="integer",
 * default="0"
 * ),
 * @SWGParameter(
 * name="limit",
 * in="query",
 * description="Limit...",
 * required=false,
 * type="integer"
 * ),
 * @SWGResponse(
 * response="200",
 * description="Returned when successful"
 * )
 * )
 *
 * @Security(name="apiKey")
 *
 * @param Request $request
 * @return JsonResponse
 */
 public function getTestAction(Request $request)
 
 $start = $request->get('start');
 $limit = $request->get('limit');

 $data = [];

 return new JsonResponse($data, 200);
 

I've also tried this approach but no luck either:

 /**
 * @Operation(
 * tags="Test API",
 * produces="application/json",
 * summary="Get a list of all...",
 * security=
 * "apiKey"
 * ,
 * @SWGParameter(
 * name="start",
 * in="query",
 * description="Offset...",
 * required=false,
 * type="integer",
 * default="0"
 * ),

symfony symfony4 nelmioapidocbundle symfony-flex

share|improve this question

asked Mar 25 at 22:14

DanDan

6,52277 gold badges3535 silver badges9292 bronze badges

add a comment | 

1

I'm using Symfony 4 and the NelmioApiDocBundle for an API.

I have the bundle setup and working but I'm trying to require an apiKey header in all endpoints by default.

I've followed the documentation but I cannot see a header of TEST-KEY when I run try it out in my /api/docs - what am I doing wrong?

nelmio_api_doc.yml

nelmio_api_doc:
 documentation:
 info:
 title: Test API
 description: Test API
 version: 1.0.0
 securityDefinitions:
 apiKey:
 type: apiKey
 description: 'My test authentication key'
 name: TEST-KEY
 in: header
 security:
 - apiKey: []
 areas:
 path_patterns:
 - ^/api(?!/doc$)

AppControllerTestController.php

 /**
 * @Operation(
 * tags="Test API",
 * produces="application/json",
 * summary="Get a list of all...",
 * @SWGParameter(
 * name="start",
 * in="query",
 * description="Offset...",
 * required=false,
 * type="integer",
 * default="0"
 * ),
 * @SWGParameter(
 * name="limit",
 * in="query",
 * description="Limit...",
 * required=false,
 * type="integer"
 * ),
 * @SWGResponse(
 * response="200",
 * description="Returned when successful"
 * )
 * )
 *
 * @Security(name="apiKey")
 *
 * @param Request $request
 * @return JsonResponse
 */
 public function getTestAction(Request $request)
 
 $start = $request->get('start');
 $limit = $request->get('limit');

 $data = [];

 return new JsonResponse($data, 200);
 

I've also tried this approach but no luck either:

 /**
 * @Operation(
 * tags="Test API",
 * produces="application/json",
 * summary="Get a list of all...",
 * security=
 * "apiKey"
 * ,
 * @SWGParameter(
 * name="start",
 * in="query",
 * description="Offset...",
 * required=false,
 * type="integer",
 * default="0"
 * ),

symfony symfony4 nelmioapidocbundle symfony-flex

share|improve this question

asked Mar 25 at 22:14

DanDan

6,52277 gold badges3535 silver badges9292 bronze badges

add a comment | 

I'm using Symfony 4 and the NelmioApiDocBundle for an API.

I have the bundle setup and working but I'm trying to require an apiKey header in all endpoints by default.

I've followed the documentation but I cannot see a header of TEST-KEY when I run try it out in my /api/docs - what am I doing wrong?

nelmio_api_doc.yml

nelmio_api_doc:
 documentation:
 info:
 title: Test API
 description: Test API
 version: 1.0.0
 securityDefinitions:
 apiKey:
 type: apiKey
 description: 'My test authentication key'
 name: TEST-KEY
 in: header
 security:
 - apiKey: []
 areas:
 path_patterns:
 - ^/api(?!/doc$)

AppControllerTestController.php

 /**
 * @Operation(
 * tags="Test API",
 * produces="application/json",
 * summary="Get a list of all...",
 * @SWGParameter(
 * name="start",
 * in="query",
 * description="Offset...",
 * required=false,
 * type="integer",
 * default="0"
 * ),
 * @SWGParameter(
 * name="limit",
 * in="query",
 * description="Limit...",
 * required=false,
 * type="integer"
 * ),
 * @SWGResponse(
 * response="200",
 * description="Returned when successful"
 * )
 * )
 *
 * @Security(name="apiKey")
 *
 * @param Request $request
 * @return JsonResponse
 */
 public function getTestAction(Request $request)
 
 $start = $request->get('start');
 $limit = $request->get('limit');

 $data = [];

 return new JsonResponse($data, 200);
 

I've also tried this approach but no luck either:

 /**
 * @Operation(
 * tags="Test API",
 * produces="application/json",
 * summary="Get a list of all...",
 * security=
 * "apiKey"
 * ,
 * @SWGParameter(
 * name="start",
 * in="query",
 * description="Offset...",
 * required=false,
 * type="integer",
 * default="0"
 * ),

symfony symfony4 nelmioapidocbundle symfony-flex

share|improve this question

asked Mar 25 at 22:14

DanDan

6,52277 gold badges3535 silver badges9292 bronze badges

nelmio_api_doc:
 documentation:
 info:
 title: Test API
 description: Test API
 version: 1.0.0
 securityDefinitions:
 apiKey:
 type: apiKey
 description: 'My test authentication key'
 name: TEST-KEY
 in: header
 security:
 - apiKey: []
 areas:
 path_patterns:
 - ^/api(?!/doc$)

 /**
 * @Operation(
 * tags="Test API",
 * produces="application/json",
 * summary="Get a list of all...",
 * @SWGParameter(
 * name="start",
 * in="query",
 * description="Offset...",
 * required=false,
 * type="integer",
 * default="0"
 * ),
 * @SWGParameter(
 * name="limit",
 * in="query",
 * description="Limit...",
 * required=false,
 * type="integer"
 * ),
 * @SWGResponse(
 * response="200",
 * description="Returned when successful"
 * )
 * )
 *
 * @Security(name="apiKey")
 *
 * @param Request $request
 * @return JsonResponse
 */
 public function getTestAction(Request $request)
 
 $start = $request->get('start');
 $limit = $request->get('limit');

 $data = [];

 return new JsonResponse($data, 200);
 

 /**
 * @Operation(
 * tags="Test API",
 * produces="application/json",
 * summary="Get a list of all...",
 * security=
 * "apiKey"
 * ,
 * @SWGParameter(
 * name="start",
 * in="query",
 * description="Offset...",
 * required=false,
 * type="integer",
 * default="0"
 * ),

share|improve this question

asked Mar 25 at 22:14

DanDan

6,52277 gold badges3535 silver badges9292 bronze badges

share|improve this question

asked Mar 25 at 22:14

DanDan

6,52277 gold badges3535 silver badges9292 bronze badges

asked Mar 25 at 22:14

DanDan

6,52277 gold badges3535 silver badges9292 bronze badges

asked Mar 25 at 22:14

DanDan

6,52277 gold badges3535 silver badges9292 bronze badges