queryParameters array from the docblock

[Qanah]

pass queryParameters array from the docblock

[Qanah]

Using for @queryParameters
the title and body is required to pass demo values you need to add @queryParameters to docblock as JSON

My TestRequest

class TestRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'title' => 'required|max:255',
            'body' => 'required',
            'type' => 'in:foo,bar',
            'thumbnail' => 'required_if:type,foo|image',
        ];
    }
}

My Test API

    /**
     *
     * This is the short description [and should be unique as anchor tags link to this in navigation menu]
     *
     * This can be an optional longer description of your API call, used within the documentation.
     *
     * @queryParameters {
     *  "title": "my test title value",
     *  "body": "my test body value"
     * }
     *
     * @param TestRequest $request
     * @return array
     */
    public function test(TestRequest $request) {

        return [
            'uuid' => uniqid(),
            'user' => [
                'name' => 'ibraheem',
                'email' => 'i.qanah@gmail.com'
            ],
            'data' => $request->all()
        ];
    }

Result

{
    "uuid": "5ba0b2d47f6bf",
    "user": {
        "name": "ibraheem",
        "email": "i.qanah@gmail.com"
    },
    "data": {
        "title": "my test title value",
        "body": "my test body value"
    }
}

[shalvah]

I think you mean $queryParamTags, not $responseTags :)

[shalvah]

Hey @Qanah thank you for this. I have a few thoughts:

• I suggest we go with something like this instead:

    /**
     *
     * @queryParam title Description of this param
     * @queryParam per_page Description of this one
     * 
     */

Reason is, I feel using a JSON object is a bit odd, since query parameters don't get passed as JSON, and are individual entities, not one JSON object. Also, this is clearer and more similar to the usual PHPDoc tags

• Also, you'd need to modify the markdown source files to include a section for query parameters.

• Can you add tests? A screenshot of how this looks in the generated documentation would also be nice.