用于 swagger Post/Put/Delete 的 Laravel 路由如下。
Route::post('/api/user', 'DashboardController@store');
Route::put('/api/user/{user_id}', 'DashboardController@edit');
Route::delete('/api/user/{user_id}', 'DashboardController@delete');
Route::get('/api/users', 'DashboardController@getData');
Route::get('/api/user/{user_id}', 'DashboardController@getDataById');
For Post
/**
* @SWG\Post(
* path="/api/user",
* tags={"User"},
* operationId="ApiV1saveUser",
* summary="Add User",
* consumes={"application/x-www-form-urlencoded"},
* produces={"application/json"},
* @SWG\Parameter(
* name="name",
* in="formData",
* required=true,
* type="string"
* ),
* @SWG\Parameter(
* name="phone",
* in="formData",
* required=true,
* type="number"
* ),
* @SWG\Response(
* response=200,
* description="Success"
* ),
*/
For Put
/**
* @SWG\Put(
* path="/api/user/{user_id}",
* tags={"User"},
* operationId="ApiV1UpdateUser",
* summary="Update User",
* consumes={"application/x-www-form-urlencoded"},
* produces={"application/json"},
* @SWG\Parameter(
* name="user_id",
* in="path",
* required=true,
* type="string"
* ),
* @SWG\Parameter(
* name="name",
* in="formData",
* required=true,
* type="string"
* ),
* @SWG\Response(
* response=200,
* description="Success"
* ),
*/
对于按 ID 删除
/**
* @SWG\Delete(
* path="/api/users",
* tags={"User"},
* operationId="ApiV1DeleteUser",
* summary="Delete User",
* @SWG\Parameter(
* name="user_id",
* in="path",
* required=true,
* type="string"
* ),
* @SWG\Response(
* response=200,
* description="Success"
* ),
*/
For Get
/**
* @SWG\Get(
* path="/api/users",
* tags={"User"},
* operationId="ApiV1GetUsers"
* summary="Get Users",
* @SWG\Response(
* response=200,
* description="Success"
* ),
*/
通过 ID 获取
/**
* @SWG\Get(
* path="/api/user/{user_id}",
* tags={"User"},
* operationId="ApiV1GetUserById",
* summary="Get User by user id",
* @SWG\Parameter(
* name="user_id",
* in="path",
* required=true,
* type="string"
* ),
* @SWG\Response(
* response=200,
* description="Success"
* ),
*/