Schema

G3-Web 提供了一个简单版本的 Schema 数据验证器，它使用注解的方式，为 Rest Api 路由添加 JSON 数据验证功能。

语法

PHP
<?phpnamespace JEALER\G3\Controllers;use JEALER\G3\Attributes\RestRouter;use JEALER\G3\Attributes\Schema;use WP_REST_Request;use WP_Error;class TestController {    /**     * 测试POST API - 创建数据     * 访问：POST /wp-json/api/v1/test/create     *     * @param WP_REST_Request $request     * @return array     */    #[RestRouter(        namespace: 'api/v1',        route: '/test/create',        methods: 'POST'    )]    // 使用 Schema 注解进行数据验证    #[Schema([        'type'            => 'object',        // 必需的参数        'required'        => ['name', 'description'],        // body 参数 属性规则        'properties'      => [            'name'        => [                'type'      => 'string',                'minLength' => 1,                'maxLength' => 100            ],            'description' => [                'type'      => 'string',                'maxLength' => 500            ]        ]    ])]    public function createData(WP_REST_Request $request): array    {        $data = $request->get_json_params();        $name        = sanitize_text_field($data['name']);        $description = sanitize_textarea_field($data['description']);        // 模拟创建数据        $created_data = [            'id'          => wp_generate_uuid4(),            'name'        => $name,            'description' => $description,            'created_at'  => current_time('mysql'),            'created_by'  => get_current_user_id()        ];        return [            'status'  => 'success',            'message' => '数据创建成功',            'data'    => $created_data        ];    }}

属性

规则

Draft 7

如果需要更强大的 JSON Schema 验证功能，推荐使用完整支持 JSON Schema Draft 7 的第三方库，如：opis/json-schema。