L5-swagger api documentation: Getting error Required @OA\PathItem() not found

Question

After reading these 2 posts here on Stackoverflow: How to Solved ErrorException : Required @OA\PathItem() not found Can't generate API documentation in l5-swagger

I still get an error Required @OA\PathItem() not found after running php artisan l5-swagger:generate.

This is my Controller.php part:

/**
 * @OA\Info(
 *     title="My First API Documentation",
 *     version="0.1",
 *      @OA\Contact(
 *          email="[email protected]"
 *      ),
 * ),
 *  @OA\Server(
 *      description="Learning env",
 *      url="https://foo.localhost:8000/api/"
 *  ),
 */
class Controller extends BaseController
{

and this is my ProfileController part:

   /**
     * @OA\Get(
     *      path="/profiles",
     *      @OA\Response(
     *          response=200,
     *          description="Successful operation",
     *      ),
     *     @OA\PathItem (
     *     ),
     * )
     */
   function index()
    {
        return new ProfileCollection(Profile::with('user')->paginate());
    }

What am I overlooking here? If anyone can explain and help that would be great :)

EDIT - SOLUTION

The problem occured because I am using a laravel modules package and I had to change a bit of code in the l5-swagger.php config file:

'annotations' => [
                    base_path('Modules/Api/Http'), <-- changed the base path to the correct module
                ],

I then copied the main Controller.php from App/Http/Controllers to the same Module to also get rid of the occuring @OA\Info() not found error after that.

I think this boils down to swagger-php requiring at least one endpoint. In the case above, it was not looking for annotations in the right path, in mine... I had none, yet. — savedario
– savedario, Commented May 11, 2023 at 13:59
After installing darkaonline/l5-swagger, Ensure your application has the necessary Swagger annotations throughout the controllers and models and the run this command again composer update and then try again php artisan l5-swagger:generate — Muhammad Shahzad
– Muhammad Shahzad, Commented Jun 3, 2024 at 7:59

aimme · Accepted Answer · 2022-08-26 19:07:01Z

10

When I first installed and configured I was having the same error. Turns out that just @OA\Info is not enough to generate the document. In addition to that, it requires atleast one path entry. After adding an api endpoint annotation it got fixed.

example:

/**
 * @OA\Get(
 *     path="/api/users",
 *     @OA\Response(response="200", description="An example endpoint")
 * )
 */
 public function getUsers() {
    ...
 }

answered Aug 26, 2022 at 19:07

aimme

6,9087 gold badges54 silver badges71 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Jzapata · Accepted Answer · 2025-01-15 23:21:11Z

2

I got this when migrating to v4.8.x, which is when doctrine/annotations was removed as a dependency.

You either need to add doctrine/annotations as a dependency or change to using PHP annotations i.e.

use OpenApi\Attributes as OA;

#[OA\Info(
    version: '1.0.0',
    title: 'My API'
)]

instead of

/**
 * @OA\Info(
 *   version="1.0.0",
 *   title="My API"
 * )
 */

You can use both types of annotations if you have a lot that you don't want to migrate all at once.

Command:

composer require doctrine/annotations

edited Jan 15 at 23:21

Jzapata

2,5122 gold badges15 silver badges10 bronze badges

answered Jan 10, 2024 at 6:40

tschumann

3,3163 gold badges36 silver badges58 bronze badges

Comments

Veshraj Joshi · Accepted Answer · 2022-03-24 07:10:00Z

0

As per migration documentation you need to import Annotations class use OpenApi\Annotations as OA; that will fix your problem.

answered Mar 24, 2022 at 7:10

Veshraj Joshi

3,5874 gold badges32 silver badges51 bronze badges

Comments

Abbosjon Abdullayev · Accepted Answer · 2023-01-31 09:53:18Z

0

/**
 * Remove the specified resource from storage.
 *
 * @return \Illuminate\Http\JsonResponse
 */

if there are these codes above my index() function, it should be deleted immediately. that's why I got this error

edited Jan 31, 2023 at 9:53

answered Jan 31, 2023 at 9:49

Abbosjon Abdullayev

11 bronze badge

1 Comment

Community Over a year ago

As it’s currently written, your answer is unclear. Please edit to add additional details that will help others understand how this addresses the question asked. You can find more information on how to write good answers in the help center.

user4157124 · Accepted Answer · 2025-04-17 00:57:03Z

0

/**
* @OA\PathItem(path="/api/v1")
*
* @OA\Info(
*      version="0.0.0",
*      title="kashtnegar API"
*  )
*/

Put this in the route of your controller. For me it is Http/controllers/controller.php.

edited Apr 17 at 0:57

user4157124

3,00821 gold badges33 silver badges48 bronze badges

answered Apr 15 at 15:15

shekoufeh_jafari

11 bronze badge

1 Comment

Jeremy Caney Apr 16 at 0:43

Thank you for your interest in contributing to the Stack Overflow community. This question already has a few answers—including at least one that has been validated by the community. It would be useful to explain how your approach is different, under what circumstances your approach might be preferred, and/or why you think the previous answers aren’t sufficient. Can you kindly edit your answer to offer an explanation?

3 revs · Accepted Answer · 2024-02-21 15:49:03Z

-1

This error typically occurs when using OpenAPI annotations (such as @OA\PathItem()) in Laravel without having the necessary packages installed. Make sure you have installed the darkaonline/l5-swagger package properly, as it provides support for OpenAPI annotations in Laravel.

If you have already installed the package, ensure that you have followed all the setup steps correctly and that your routes and annotations are properly defined. If the issue persists, you may need to review your code and configuration to identify any missing or misconfigured elements.

edited Feb 21, 2024 at 15:49

community wiki

3 revs
hmairi halim

1 Comment

Nico Haase Over a year ago

Please share more details, such that others can learn from your answer, and share all details in text form

Collectives™ on Stack Overflow

L5-swagger api documentation: Getting error Required @OA\PathItem() not found

6 Answers 6

Comments

Comments

Comments

1 Comment

1 Comment

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

Comments

Comments

Comments

1 Comment

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related