Laravel-apidoc-generator: use validate method to display a list of valid parameters instead Formrequest

[ahmadbadpey]

From https://github.com/mpociot/laravel-apidoc-generator#form-request-validation-rules , seems that it's required to write FormRequest to create list of valid parameters.

But there is situation that we do not use FormRequest and prefer to use other validation methods like $request->validate :

public function store(Request $request)
{
    $validatedData = $request->validate([
        'title' => 'required|unique:posts|max:255',
        'body' => 'required',
    ]);

    // The blog post is valid...
}

how can I generate valid parameters of methods in this case ?

[TomKFisher]

This would be very useful as bigger projects with more specific rules would benefit from this.

[mark1282]

I agree, many projects don't make use of FormRequests so this would be a useful feature.

[autaut03]

Hey guys. I'm currently working on a fork, which is gonna be fully rewritten. I would be very grateful if you helped me and told what could be the benefit of using $request->validate over FormRequest classes.

[mark1282]

I think a lot of comes down to personal preference. If I'm using a form which is going to have common fields I would probably use a FormRequest class. However if I'm working with a lot of specific forms I would probably just write the validation rules in the method or construct. With this in mind, I'd find it very useful having this feature. If there is anything I can do to help to contribute to this project I'd be more than happy to.

[autaut03]

@mark1282 Any ideas on how to parse authorize(), custom rules and maybe even responses?

Sure enough we're speaking about parsing the code which is quite difficult. On the other hand, with that method if app is built correctly then generator will be able to parse everything on it's own, which is amazing and more than enough for internal APIs.

[oxycoder]

Take a look at my fork, I have implemented this feature
https://github.com/oxycoder/laravel-apidoc-generator
This repo seem abadoned

[edgreenberg]

@oxycoder I really like what you did in your fork. I'm using the feature where you parse $request->validator() Could you please turn on issues in your repo? I would like to comment.

[oxycoder]

@edgreenberg sure

[shalvah]

Hey everyone. This feature is in high demand, and we're open to adding it. It's on the map, but we'll accept any PRs to fast-track it.

[shalvah]

No longer valid because of #343