Hello!

I am testing your package with some Laravel projects and I have a question for the generated route list. For now, I am using a random Laravel with default config of your package.

In my generated HTML, the routes are sorted by their method. Is it possible to sort them by name/prefix, or I am doing something wrong?

Thanks!

Would be great if the open API version of the output could be downloaded

The invokable controllers are not in the list after generation.

Related to #38

When rules in the request class throw exceptions, the docs currently skip scanning that route.
We have made previous attempts to fetch rules via reg exp, but that way is too tricky and has high chances to produce wrong results.

Fetching of the rule may fail because of preconditions such as #8 or methods such as findOrFail.

The solution is to provide a middleware class that the user can configure - where pre-conditions such as load Auth fake user, or seed data can be added.

Is any type of return properties list supported or we should execute an example request to be able to see the response format ?
I am using ...Resource classes (something like below) to be returned from each controller method response so the returned keys could be extracted the same way as they are for Request classes:

<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class ClientResource extends JsonResource
{
    public function toArray($request): array
    {
        return [
            'id' => $this->id,
            'displayName' => $this->display_name,
        ];
    }
}

My api.php code looks like:

GET, POST, DELETE routes looks nicely grouped:

But PUT routes are separated to duplicated records for some reason:

Any ideas why?

Using 1.6 package version.

In my dev server, everything works great, but I'm running php 7.4. In my production servicer, we have php 8.1.3 and I'm getting 404 on /request-docs/

Could it be the php version?

What a nice package, I am enjoying it, But one little thing I want to have is:
I have different API scopes in my project, some of them are for interacting with the front app, some of them are for mobile and etc.

The package should have a config for separating scopes and for a big project it is better to categorize APIs.

Can you add Support form sanctum middleware "auth:sanctum"? i want to add Bearer Header

It's possible to publish vendor/rakutentech/laravel-request-docs/resources/views/index.blade.php in order to modify some of the html render ?

Hello! Maybe it's not an issue, but why don't I have sql displayed when querying?

If use API Resources Route, the Endpoint duplicated the Update Method Endpoint will appear duplicated in /request-docs.

Hello my name is teguh, i have one question here. I want to hide all route but show only route with prefix /api/

See image below

Good morning

Just a feature request for the JSON request structure. I like the way the generation for API documentation grabs the request rules.

Would like to just see it in JSON object format.

from this:

{ "dealership.dealership_group_id": "", "company.brand_name": "", "company.trading_name": "", "company.registered_name": "", "company.reg_no": "", "company.vat_no": "", "company.email": "", "company.telephone": "", "company.website_url": "", "address.unit_no": "", "address.line1": "", "address.line2": "", "address.post_code": "", "address.province": "", "address.country": "" }

To this:

{ "dealership":{ "dealership_group_id":"" }, "company":{ "brand_name":"", "trading_name":"", "registered_name":"", "reg_no":"", "vat_no":"", "email":"", "telephone":"", "website_url":"" }, "address":{ "unit_no":"", "line1":"", "line2":"", "post_code":"", "province":"", "country":"" } }

If you have a rule like "string|required|min:1" then "string" also appears in rules. I think its enough if you can see it in the type, its crystal clear that then string is in the rules

Trying to get property 'id' of non-object

Call to a member function hasRole() on null

Hi, I apologize of course, but I could not find a solution to this problem, can you tell me how to fix it

I got issue when using package have using json input but it's not work please check it out!
I guess I do something wrong maybe...

I have two routes - mobile and back office. I would like them to be grouped by route name and method when filtering. It would be nice to add a separation between these methods, but I understand that this is a rare case.

//RouteServiceProvider::class

$this->routes(function () {
    Route::prefix('backoffice/api/v1')
        ->middleware('backoffice.api')
        ->name('backoffice.api.v1.')
        ->namespace($this->namespace)
        ->group(base_path('routes/api/backoffice/v1.php'));
    
    Route::prefix('mobile/api/v1')
        ->middleware('mobile.api')
        ->name('mobile.api.v1.')
        ->namespace($this->namespace)
        ->group(base_path('routes/api/mobile/v1.php'));
    });
}

Hello,

I was testing this LRD and its very simple to start, thanks for that. Unfortunately when i run the endpoints it gives me a 200 but i see no response body.
This is all i see after running the endpoint with the Bearer already filled that i have to get from PostMan because i can not get a response from the login:

I am returning resources, but i tried returning only an array and it did not work.

Am I doing something wrong? This is working perfectly fine in swagger if I do the whole process of creating the annotations.

Thank you

Hiding some routes would be great, is there a way to do this?

BTW thank you for this package, it's great!

Enums are allowed as a query parameter - it would be great if it could read this and identify the possible routes based on this.

Moreover, generally identifying the data type of the route param would be great.

For example; for uuids:
/users/{record} => record: string

For autonumber ids:
/users/{record} => record: integer

Where model is an enum, record is string:
/{model}/{record} => model: enum [users, projects, tasks, quotes]

Probably displayed as a table, such as:

Query Params:

Field    | Type   | Data
===================================
model    | enum   | users, projects, tasks, quotes
-----------------------------------
record   | string |
-----------------------------------

If i use the url and try authenticate via the docs i always get a error as it was the CSRF token which is not needed for the sanctum api request.

If i export to postman and click the button to post to auth then i get the response i am looking for..

If i try postman i get the correct response:

#102

Hi,
I'm a developer for a laravel api and i want build docs with your packages.

It's more important to open the possibility to test method_exist(rules) instaed instanceof FormRequest test.

I've RequestClasses that are not inherited from FormRequest class. It's important to test parameter instance has rules() method.

Please take a look at this video: https://www.youtube.com/watch?v=gp-_kcblYGA

Would be great if requests that require auth can be run from the documentation page.

Middleware: https://github.com/rakutentech/laravel-request-docs/blob/master/src/LaravelRequestDocsMiddleware.php
Source: https://github.com/kitloong/laravel-app-logger/blob/1.x/src/QueryLog/LogWriter.php

MIT License: @kitloong
rakutentech contributor: @kitloong

Hello all,

I am having problems defining the variable that we pass in the URL:

Any idea how to define it?

Thank you

If you have a parameter like a billing address you cant make an array "billing" containing values like "firstname" and "lastname". Instead you need to need make "billing_firstname" and "billing_lastname"

Also related here: #15

Having laravel 8.5.8 installed and LRD in 1.22 running into the error:

$ php artisan lrd:generate

   Error

  Call to undefined method ReflectionUnionType::getName()

  at C:\Users\****\****\vendor\rakutentech\laravel-request-docs\src\LaravelRequestDocs.php:126
    122▕             foreach ($params as $param) {
    123▕                 if (!$param->getType()) {
    124▕                     continue;
    125▕                 }
  ➜ 126▕                 $requestClassName = $param->getType()->getName();
    127▕                 $requestClass = null;
    128▕                 try {
    129▕                     $requestClass = new $requestClassName();
    130▕                 } catch (Throwable $th) {

  1   C:\Users\****\****\vendor\rakutentech\laravel-request-docs\src\LaravelRequestDocs.php:18
      Rakutentech\LaravelRequestDocs\LaravelRequestDocs::appendRequestRules()

  2   C:\Users\****\****\vendor\rakutentech\laravel-request-docs\src\Commands\LaravelRequestDocsCommand.php:30
      Rakutentech\LaravelRequestDocs\LaravelRequestDocs::getDocs()

php artisan route:list is emitting every single route correctly. I haven't changed anything in config, project etc.