Laravel中API Platform无法使用自定义控制器方法作为路由

你的问题出在#[Get]注解的controller参数写法错误，API Platform不支持控制器类::方法名这种拼接写法；同时路由匹配顺序可能导致默认的Item操作优先拦截了/jobs/test请求，返回了数据库中的Job数据。

下面提供两种可行的解决方案：

方案一：在模型注解中定义自定义操作（关联API Platform） #

修改模型的注解，指定控制器类而非带方法名的字符串，同时让控制器实现__invoke方法（API Platform默认会调用该方法）：

// app/Models/Job.php
#[ApiResource]
#[GetCollection]
#[Get(
    uriTemplate: '/jobs/test',
    controller: App\Http\Controllers\JobTestController::class,
    name: 'jobs_test'
)]
class Job extends Model
{
    // ... 模型属性和其他代码
}

创建对应的控制器类：

// app/Http/Controllers/JobTestController.php
namespace App\Http\Controllers;

use Illuminate\Http\JsonResponse;

class JobTestController
{
    public function __invoke(): JsonResponse
    {
        return response()->json([
            'message' => 'This is my test',
        ]);
    }
}

方案二：直接用Laravel路由注解（灵活自定义） #

如果你不需要该端点关联API Platform的模型资源，可以直接在控制器上用Laravel原生的#[Route]注解定义路由，完全脱离模型的API Resource配置：

// app/Http/Controllers/JobController.php
namespace App\Http\Controllers;

use Illuminate\Http\JsonResponse;
use Illuminate\Routing\Route;

class JobController extends Controller
{
    #[Route('/jobs/test', methods: ['GET'])]
    public function test(): JsonResponse
    {
        return response()->json([
            'message' => 'This is my test',
        ]);
    }
}

如果需要让该端点出现在API Platform的文档中，可以添加API Platform的注解补充元数据：

use ApiPlatform\Metadata\ApiOperation;
use ApiPlatform\Metadata\ApiResponse;

// ...

#[Route('/jobs/test', methods: ['GET'])]
#[ApiOperation(
    summary: '自定义测试端点',
    description: '返回测试消息'
)]
#[ApiResponse(
    response: 200,
    description: '请求成功',
    content: new \ApiPlatform\Metadata\JsonContent(
        type: 'object',
        properties: [
            'message' => ['type' => 'string']
        ]
    )
)]
public function test(): JsonResponse
{
    return response()->json([
        'message' => 'This is my test',
    ]);
}

内容的提问来源于stack exchange，提问作者naspy971