Be part of JetBrains PHPverse 2026 on June 9 – a free online event bringing PHP devs worldwide together.

isong1234's avatar

How to document api using SCRIBE in lumen application with urlParam and QueryParam at the same time??

Hello Everyone, Im new here and I want to something about how scribe works in my lumen application. This is all about documenting of an api using scribe.. it return server error. i dont know why, tested in postman and it works successfully but in scribe it returns server error. here is my code.. pls help me..

web.routes:

 $router->group(['prefix' => 'cost-calculations'], function () use ($router) {
        $router->get('/{costCalculation}/cost-calculation-details', 'CostCalculationDetailController@index');
 });

CostCalculationDetailController:

/**
* Get Cost Calculation Details Li
*  
* @urlParam id_cost_calculation required The id_cost_calculation of CostCalculation.
* @queryParam inside_outside_visit integer required (0 or 1) Specifies whether it's an inside or outside visit.
* @queryParam filters string optional The billing_item_name search keyword of Site Billing Item.
*
* @param \App\Http\Requests\V2\CostCalculationDetail\CostCalculationDetailIndexRequest $request
* @param \App\Models\V2\CostCalculation $costCalculation
* @return \Illuminate\Http\JsonResponse
*/
public function index(CostCalculationDetailIndexRequest $request, CostCalculation $costCalculation)
{
    $this->authorize('index', [CostCalculationDetail::class, $costCalculation->id_site, $costCalculation->id_project]);
    
    $costCalculationDetails = $this->resourceService->getList($costCalculation->id_cost_calculation, $request->inside_outside_visit, $request->filters);

    return $this->responseSuccessResource(CostCalculationDetailResource::collection($costCalculationDetails));
}
0 likes
0 replies

Please or to participate in this conversation.