Add QRCode documentation

This commit is contained in:
Djery-Tom 2021-11-15 16:59:42 +01:00
parent 8e8f42f416
commit 576d4e5062
3 changed files with 68 additions and 4 deletions

View File

@ -23,7 +23,7 @@ class InsuredController extends Controller
/**
* @OA\Get(
* path="/insured/search",
* path="/insured",
* summary="Rechercher un assuré",
* tags={"Assurés"},
* security={{"api_key":{}}},
@ -67,7 +67,7 @@ class InsuredController extends Controller
* )
* )
*/
public function searchInsured(Request $request)
public function getInsured(Request $request)
{
$name = $request->input('name');
$phone = $request->input('phone');

View File

@ -56,13 +56,77 @@ class QRCodeController extends Controller
}
}
//Generer le QRCode d'un utilisateur à partir de son id
/**
* @OA\Get(
* path="/qrcode/read/{id_user}",
* summary="Lire les informations à partir de l'id de l'utilisateur obtenu en scanant le QRCode",
* tags={"QRCode"},
* security={{"api_key":{}}},
* @OA\Parameter(
* parameter="id_user",
* name="id_user",
* description="ID de l'utilisateur",
* @OA\Schema(
* type="integer"
* ),
* in="path",
* required=true
* ),
* @OA\Response(
* response=200,
* description="OK",
* @OA\JsonContent(
* ref="#/components/schemas/ApiResponse",
* example = {
* "status" : 200,
* "response" : {"id":349,"uid":"5fcb90ab7197f8.26608831",
* "firstname":null,"lastname":"Tom Di","phone":"+237690716648","email":"ddoubletom@gmail.com","user_code":"vdVtq7ym9S","numero_carte":null,
* "expiration_date":null,"adresse":"kotto","solde":0,"salt":"dbbaea33d9","validation_code":"xuty8dbq","active":1,"date_modified":"2020-12-05T14:52:43.000000Z",
* "date_created":"2020-12-05T14:52:43.000000Z","network_id":185,"group_id":null,"balance_credit":0,"balance_epargne":0,"balance_nano_health":11335000,
* "date_adhesion":null,"id_bank_country":null,"iban":null},
* "error":null
* }
* )
* )
* )
*/
//Lire les infos d'un utilisateur à partir de son id
public function read($id_user)
{
$user = User::findOrFail($id_user);
return $this->successResponse($user);
}
/**
* @OA\Get(
* path="/qrcode/image/{id_user}",
* summary="Generer l'image du QRCode d'un utilisateur à partir de son id",
* tags={"QRCode"},
* security={{"api_key":{}}},
* @OA\Parameter(
* parameter="id_user",
* name="id_user",
* description="ID de l'utilisateur",
* @OA\Schema(
* type="integer"
* ),
* in="path",
* required=true
* ),
* @OA\Response(
* response=200,
* description="OK",
* @OA\JsonContent(
* ref="#/components/schemas/ApiResponse",
* example = {
* "status" : 200,
* "response" : "image en base64",
* "error":null
* }
* )
* )
* )
*/
//Generer l'image du QRCode d'un utilisateur à partir de son id
public function image($id_user)
{

View File

@ -34,7 +34,7 @@ $router->group(['prefix' => '', 'middleware' => 'auth'], function () use ($route
// Insurances routes
$router->group(['prefix' => '/insured'], function () use ($router) {
//Search
$router->get('search', 'InsuredController@searchInsured');
$router->get('', 'InsuredController@getInsured');
});