feat(api): Implement API Resource Standard compliance
- Create BaseResource with formatDate() and formatDecimal() utilities - Create 11 API Resource classes for all models - Update all 6 controllers to return wrapped responses via wrapResource() - Update frontend API client with unwrapResponse() helper - Update all 63+ backend tests to expect 'data' wrapper - Regenerate Scribe API documentation BREAKING CHANGE: All API responses now wrap data in 'data' key per architecture spec. Backend Tests: 70 passed, 5 failed (unrelated to data wrapper) Frontend Unit: 10 passed E2E Tests: 102 passed, 20 skipped API Docs: Generated successfully Refs: openspec/changes/api-resource-standard
This commit is contained in:
@@ -3,6 +3,7 @@
|
||||
namespace App\Http\Controllers\Api;
|
||||
|
||||
use App\Http\Controllers\Controller;
|
||||
use App\Http\Resources\TeamMemberResource;
|
||||
use App\Models\TeamMember;
|
||||
use App\Services\TeamMemberService;
|
||||
use Illuminate\Http\JsonResponse;
|
||||
@@ -35,13 +36,53 @@ class TeamMemberController extends Controller
|
||||
* Get a list of all team members with optional filtering by active status.
|
||||
*
|
||||
* @authenticated
|
||||
*
|
||||
* @queryParam active boolean Filter by active status. Example: true
|
||||
*
|
||||
* @response 200 [
|
||||
* {
|
||||
* @response 200 {
|
||||
* "data": [
|
||||
* {
|
||||
* "id": "550e8400-e29b-41d4-a716-446655440000",
|
||||
* "name": "John Doe",
|
||||
* "role": {
|
||||
* "id": 1,
|
||||
* "name": "Backend Developer"
|
||||
* },
|
||||
* "hourly_rate": "150.00",
|
||||
* "active": true,
|
||||
* "created_at": "2024-01-15T10:00:00.000000Z",
|
||||
* "updated_at": "2024-01-15T10:00:00.000000Z"
|
||||
* }
|
||||
* ]
|
||||
* }
|
||||
*/
|
||||
public function index(Request $request): JsonResponse
|
||||
{
|
||||
$active = $request->has('active')
|
||||
? filter_var($request->query('active'), FILTER_VALIDATE_BOOLEAN)
|
||||
: null;
|
||||
|
||||
$teamMembers = $this->teamMemberService->getAll($active);
|
||||
|
||||
return $this->wrapResource(TeamMemberResource::collection($teamMembers));
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new team member
|
||||
*
|
||||
* Create a new team member with name, role, and hourly rate.
|
||||
*
|
||||
* @authenticated
|
||||
*
|
||||
* @bodyParam name string required Team member name. Example: John Doe
|
||||
* @bodyParam role_id integer required Role ID. Example: 1
|
||||
* @bodyParam hourly_rate numeric required Hourly rate (must be > 0). Example: 150.00
|
||||
* @bodyParam active boolean Active status (defaults to true). Example: true
|
||||
*
|
||||
* @response 201 {
|
||||
* "data": {
|
||||
* "id": "550e8400-e29b-41d4-a716-446655440000",
|
||||
* "name": "John Doe",
|
||||
* "role_id": 1,
|
||||
* "role": {
|
||||
* "id": 1,
|
||||
* "name": "Backend Developer"
|
||||
@@ -51,42 +92,6 @@ class TeamMemberController extends Controller
|
||||
* "created_at": "2024-01-15T10:00:00.000000Z",
|
||||
* "updated_at": "2024-01-15T10:00:00.000000Z"
|
||||
* }
|
||||
* ]
|
||||
*/
|
||||
public function index(Request $request): JsonResponse
|
||||
{
|
||||
$active = $request->has('active')
|
||||
? filter_var($request->query('active'), FILTER_VALIDATE_BOOLEAN)
|
||||
: null;
|
||||
|
||||
$teamMembers = $this->teamMemberService->getAll($active);
|
||||
|
||||
return response()->json($teamMembers);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new team member
|
||||
*
|
||||
* Create a new team member with name, role, and hourly rate.
|
||||
*
|
||||
* @authenticated
|
||||
* @bodyParam name string required Team member name. Example: John Doe
|
||||
* @bodyParam role_id integer required Role ID. Example: 1
|
||||
* @bodyParam hourly_rate numeric required Hourly rate (must be > 0). Example: 150.00
|
||||
* @bodyParam active boolean Active status (defaults to true). Example: true
|
||||
*
|
||||
* @response 201 {
|
||||
* "id": "550e8400-e29b-41d4-a716-446655440000",
|
||||
* "name": "John Doe",
|
||||
* "role_id": 1,
|
||||
* "role": {
|
||||
* "id": 1,
|
||||
* "name": "Backend Developer"
|
||||
* },
|
||||
* "hourly_rate": "150.00",
|
||||
* "active": true,
|
||||
* "created_at": "2024-01-15T10:00:00.000000Z",
|
||||
* "updated_at": "2024-01-15T10:00:00.000000Z"
|
||||
* }
|
||||
* @response 422 {"message":"Validation failed","errors":{"name":["The name field is required."],"hourly_rate":["Hourly rate must be greater than 0"]}}
|
||||
*/
|
||||
@@ -94,7 +99,8 @@ class TeamMemberController extends Controller
|
||||
{
|
||||
try {
|
||||
$teamMember = $this->teamMemberService->create($request->all());
|
||||
return response()->json($teamMember, 201);
|
||||
|
||||
return $this->wrapResource(new TeamMemberResource($teamMember), 201);
|
||||
} catch (ValidationException $e) {
|
||||
return response()->json([
|
||||
'message' => 'Validation failed',
|
||||
@@ -109,20 +115,22 @@ class TeamMemberController extends Controller
|
||||
* Get details of a specific team member by ID.
|
||||
*
|
||||
* @authenticated
|
||||
*
|
||||
* @urlParam id string required Team member UUID. Example: 550e8400-e29b-41d4-a716-446655440000
|
||||
*
|
||||
* @response 200 {
|
||||
* "id": "550e8400-e29b-41d4-a716-446655440000",
|
||||
* "name": "John Doe",
|
||||
* "role_id": 1,
|
||||
* "role": {
|
||||
* "id": 1,
|
||||
* "name": "Backend Developer"
|
||||
* },
|
||||
* "hourly_rate": "150.00",
|
||||
* "active": true,
|
||||
* "created_at": "2024-01-15T10:00:00.000000Z",
|
||||
* "updated_at": "2024-01-15T10:00:00.000000Z"
|
||||
* "data": {
|
||||
* "id": "550e8400-e29b-41d4-a716-446655440000",
|
||||
* "name": "John Doe",
|
||||
* "role": {
|
||||
* "id": 1,
|
||||
* "name": "Backend Developer"
|
||||
* },
|
||||
* "hourly_rate": "150.00",
|
||||
* "active": true,
|
||||
* "created_at": "2024-01-15T10:00:00.000000Z",
|
||||
* "updated_at": "2024-01-15T10:00:00.000000Z"
|
||||
* }
|
||||
* }
|
||||
* @response 404 {"message":"Team member not found"}
|
||||
*/
|
||||
@@ -136,7 +144,7 @@ class TeamMemberController extends Controller
|
||||
], 404);
|
||||
}
|
||||
|
||||
return response()->json($teamMember);
|
||||
return $this->wrapResource(new TeamMemberResource($teamMember));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -145,24 +153,27 @@ class TeamMemberController extends Controller
|
||||
* Update details of an existing team member.
|
||||
*
|
||||
* @authenticated
|
||||
*
|
||||
* @urlParam id string required Team member UUID. Example: 550e8400-e29b-41d4-a716-446655440000
|
||||
*
|
||||
* @bodyParam name string Team member name. Example: John Doe
|
||||
* @bodyParam role_id integer Role ID. Example: 1
|
||||
* @bodyParam hourly_rate numeric Hourly rate (must be > 0). Example: 175.00
|
||||
* @bodyParam active boolean Active status. Example: false
|
||||
*
|
||||
* @response 200 {
|
||||
* "id": "550e8400-e29b-41d4-a716-446655440000",
|
||||
* "name": "John Doe",
|
||||
* "role_id": 1,
|
||||
* "role": {
|
||||
* "id": 1,
|
||||
* "name": "Backend Developer"
|
||||
* },
|
||||
* "hourly_rate": "175.00",
|
||||
* "active": false,
|
||||
* "created_at": "2024-01-15T10:00:00.000000Z",
|
||||
* "updated_at": "2024-01-15T11:00:00.000000Z"
|
||||
* "data": {
|
||||
* "id": "550e8400-e29b-41d4-a716-446655440000",
|
||||
* "name": "John Doe",
|
||||
* "role": {
|
||||
* "id": 1,
|
||||
* "name": "Backend Developer"
|
||||
* },
|
||||
* "hourly_rate": "175.00",
|
||||
* "active": false,
|
||||
* "created_at": "2024-01-15T10:00:00.000000Z",
|
||||
* "updated_at": "2024-01-15T11:00:00.000000Z"
|
||||
* }
|
||||
* }
|
||||
* @response 404 {"message":"Team member not found"}
|
||||
* @response 422 {"message":"Validation failed","errors":{"hourly_rate":["Hourly rate must be greater than 0"]}}
|
||||
@@ -179,10 +190,10 @@ class TeamMemberController extends Controller
|
||||
|
||||
try {
|
||||
$teamMember = $this->teamMemberService->update($teamMember, $request->only([
|
||||
'name', 'role_id', 'hourly_rate', 'active'
|
||||
'name', 'role_id', 'hourly_rate', 'active',
|
||||
]));
|
||||
|
||||
return response()->json($teamMember);
|
||||
return $this->wrapResource(new TeamMemberResource($teamMember));
|
||||
} catch (ValidationException $e) {
|
||||
return response()->json([
|
||||
'message' => 'Validation failed',
|
||||
@@ -197,6 +208,7 @@ class TeamMemberController extends Controller
|
||||
* Delete a team member. Cannot delete if member has allocations or actuals.
|
||||
*
|
||||
* @authenticated
|
||||
*
|
||||
* @urlParam id string required Team member UUID. Example: 550e8400-e29b-41d4-a716-446655440000
|
||||
*
|
||||
* @response 200 {"message":"Team member deleted successfully"}
|
||||
|
||||
Reference in New Issue
Block a user