johnylemon / laravel-apidocs Goto Github PK

It's awesome package which allows one to use standartised way to show api endpoint docs, but the issues here is that the try function wont work in majority of cases as api key or other form of auth is usually required for api.

When running php artisan command php artisan apidocs:endpoint SampleEndpoint I get the following error:

Call to undefined function Johnylemon\Apidocs\Console\Commands\stub()

  at vendor/johnylemon/laravel-apidocs/src/Console/Commands/Make.php:46
     42▕         // target path
     43▕         //
     44▕         $path = app_path("$dir/$class.php");
     45▕ 
  ➜  46▕         stub($this->stub(), $path, [
     47▕             'NAMESPACE' => $this->namespace($dir),
     48▕             'NAME' => $class,
     49▕         ]);
     50▕     }

      +13 vendor frames 
  14  artisan:37
      Illuminate\Foundation\Console\Kernel::handle()

Thank you for this great package! Really nice way of handling api documentation!

As I mostly use Route::resource and Route::ApiResource instead of Route::get etc. it would be really nice to be able to add it apidoc as in: Route::resource('/rooms', "Rooms\RoomsController")->apidocs(\App\Apidocs\Endpoints\Rooms::class);

Is there a chance this can be easily added?

Thank you for great effort you made.

I followed along with steps but when I am running php artisan apidocs:generate no docs was generated. No even any errors are shown.

Here's my files

routes/api.php

Route::post('v1/register', [AuthController::class, 'register'])->apidocs(RegisterEndpoint::class);

app/Apidocs/Endpoints/RegisterEndpoint.php

...
public function describe(): void
    {
        $this->title('Register')
            ->description('Register a new account');
    }
...