10993643100

Committed 23 Sep 2024 11:49AM UTC coverage: 7.353% (-0.5%) from 7.833%

Build # 10993643100

Build Type

push

github

Committed by

web-flow

Commit Message

fix(laravel): swagger ui authentication (#6661)

fix swagger ui authentication in laravel, by providing necessary options

Closes: #6662

Run Details

0 of 43 new or added lines in 3 files covered. (0.0%)

1761 existing lines in 113 files now uncovered.

12127 of 164922 relevant lines covered (7.35%)

27.02 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/Laravel/config/api-platform.php

<?php

use ApiPlatform\Metadata\UrlGeneratorInterface;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Auth\AuthenticationException;

return [
    'title' => 'API Platform',
    'description' => 'My awesome API',
    'version' => '1.0.0',

    'routes' => [
    ],

    /*
     * Where are ApiResource defined
     * TODO: link the docs on how to plug on eloquent models or create apiResource like controllers :D
     */
    'resources' => [
        app_path('Models'),
    ],

    'formats' => [
        'jsonld' => ['application/ld+json'],
        //'jsonapi' => ['application/vnd.api+json'],
        //'csv' => ['text/csv'],
    ],

    'patch_formats' => [
        'json' => ['application/merge-patch+json'],
    ],

    'docs_formats' => [
        'jsonld' => ['application/ld+json'],
        //'jsonapi' => ['application/vnd.api+json'],
        'jsonopenapi' => ['application/vnd.openapi+json'],
        'html' => ['text/html'],
    ],

    'error_formats' => [
        'jsonproblem' => ['application/problem+json'],
    ],

    'defaults' => [
        'pagination_enabled' => true,
        'pagination_partial' => false,
        'pagination_client_enabled' => false,
                'pagination_client_items_per_page' => false,
                'pagination_client_partial' => false,
                'pagination_items_per_page' => 30,
                'pagination_maximum_items_per_page' => 30,
        'route_prefix' => '/api',
        'middleware' => [],
    ],

        'pagination' => [
                'page_parameter_name' => 'page',
                'enabled_parameter_name' => 'pagination',
                'items_per_page_parameter_name' => 'itemsPerPage',
                'partial_parameter_name' => 'partial',
        ],

    'graphql' => [
        'enabled' => false,
        'nesting_separator' => '__',
        'introspection' => ['enabled' => true]
    ],

    'exception_to_status' => [
        AuthenticationException::class => 401,
        AuthorizationException::class => 403
    ],

    'swagger_ui' => [
        'enabled' => true,
        //'apiKeys' => [
        //    'api' => [
        //        'type' => 'Bearer',
        //        'name' => 'Authentication Token',
        //        'in' => 'header'
        //    ]
        //],
        //'oauth' => [
        //    'enabled' => true,
        //    'type' => 'oauth2',
        //    'flow' => 'authorizationCode',
        //    'tokenUrl' => '',
        //    'authorizationUrl' =>'',
        //    'refreshUrl' => '',
        //    'scopes' => ['scope1' => 'Description scope 1'],
        //    'pkce' => true
        //]
    ],

    'url_generation_strategy' => UrlGeneratorInterface::ABS_PATH,

    'serializer' => [
        'hydra_prefix' => false,
        // 'datetime_format' => \DateTimeInterface::RFC3339
    ]
];

1	<?php
2
3	use ApiPlatform\Metadata\UrlGeneratorInterface;
4	use Illuminate\Auth\Access\AuthorizationException;
5	use Illuminate\Auth\AuthenticationException;
6
7	return [	×
8	'title' => 'API Platform',	×
9	'description' => 'My awesome API',	×
10	'version' => '1.0.0',	×
11
12	'routes' => [	×
13	],	×
14
15	/*
16	* Where are ApiResource defined
17	* TODO: link the docs on how to plug on eloquent models or create apiResource like controllers :D
18	*/
19	'resources' => [	×
20	app_path('Models'),	×
21	],	×
22
23	'formats' => [	×
24	'jsonld' => ['application/ld+json'],	×
25	//'jsonapi' => ['application/vnd.api+json'],	×
26	//'csv' => ['text/csv'],	×
27	],	×
28
29	'patch_formats' => [	×
30	'json' => ['application/merge-patch+json'],	×
31	],	×
32
33	'docs_formats' => [	×
34	'jsonld' => ['application/ld+json'],	×
35	//'jsonapi' => ['application/vnd.api+json'],
36	'jsonopenapi' => ['application/vnd.openapi+json'],	×
37	'html' => ['text/html'],	×
38	],	×
39
40	'error_formats' => [	×
41	'jsonproblem' => ['application/problem+json'],	×
42	],	×
43
44	'defaults' => [	×
45	'pagination_enabled' => true,	×
46	'pagination_partial' => false,	×
47	'pagination_client_enabled' => false,	×
48	'pagination_client_items_per_page' => false,	×
49	'pagination_client_partial' => false,	×
50	'pagination_items_per_page' => 30,	×
51	'pagination_maximum_items_per_page' => 30,	×
52	'route_prefix' => '/api',	×
53	'middleware' => [],	×
54	],	×
55
56	'pagination' => [	×
57	'page_parameter_name' => 'page',	×
58	'enabled_parameter_name' => 'pagination',	×
59	'items_per_page_parameter_name' => 'itemsPerPage',	×
60	'partial_parameter_name' => 'partial',	×
61	],	×
62
63	'graphql' => [	×
64	'enabled' => false,	×
65	'nesting_separator' => '__',	×
66	'introspection' => ['enabled' => true]	×
67	],	×
68
69	'exception_to_status' => [	×
70	AuthenticationException::class => 401,	×
71	AuthorizationException::class => 403	×
72	],	×
73
74	'swagger_ui' => [	×
NEW 75	'enabled' => true,	×
NEW 76	//'apiKeys' => [	×
NEW 77	// 'api' => [	×
NEW 78	// 'type' => 'Bearer',	×
NEW 79	// 'name' => 'Authentication Token',	×
NEW 80	// 'in' => 'header'	×
NEW 81	// ]	×
NEW 82	//],	×
NEW 83	//'oauth' => [	×
NEW 84	// 'enabled' => true,	×
NEW 85	// 'type' => 'oauth2',	×
NEW 86	// 'flow' => 'authorizationCode',	×
NEW 87	// 'tokenUrl' => '',	×
NEW 88	// 'authorizationUrl' =>'',	×
NEW 89	// 'refreshUrl' => '',	×
NEW 90	// 'scopes' => ['scope1' => 'Description scope 1'],	×
NEW 91	// 'pkce' => true	×
NEW 92	//]	×
UNCOV 93	],	×
94
95	'url_generation_strategy' => UrlGeneratorInterface::ABS_PATH,	×
96
97	'serializer' => [	×
98	'hydra_prefix' => false,	×
99	// 'datetime_format' => \DateTimeInterface::RFC3339	×
100	]	×
101	];	×

api-platform / core / 10993643100

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous