update api doc

This commit is contained in:
2026-03-18 09:13:53 +08:00
parent f3f73935e1
commit 88df42fe52
9 changed files with 29 additions and 25 deletions
@@ -15,7 +15,7 @@ use Hyperf\HttpServer\Annotation\RequestMapping;
use OpenApi\Attributes as OA;
use Psr\Http\Message\ResponseInterface;
#[OA\Tag(name: 'RouteGroups', description: '路由组管理')]
#[OA\Tag(name: 'Route Groups', description: '路由组管理')]
#[Controller(prefix: "/api/v1/route-groups")]
class RouteGroupController extends AbstractController
{
@@ -29,7 +29,7 @@ class RouteGroupController extends AbstractController
summary: '路由组列表',
description: '返回所有路由组,包含每组的路由数量',
security: [['bearerAuth' => []]],
tags: ['RouteGroups'],
tags: ['Route Groups'],
responses: [
new OA\Response(
response: 200,
@@ -76,7 +76,7 @@ class RouteGroupController extends AbstractController
path: '/route-groups',
summary: '创建路由组',
security: [['bearerAuth' => []]],
tags: ['RouteGroups'],
tags: ['Route Groups'],
requestBody: new OA\RequestBody(
required: true,
content: new OA\JsonContent(
@@ -198,7 +198,7 @@ class RouteGroupController extends AbstractController
path: '/route-groups/{id}',
summary: '更新路由组',
security: [['bearerAuth' => []]],
tags: ['RouteGroups'],
tags: ['Route Groups'],
parameters: [
new OA\Parameter(name: 'id', in: 'path', required: true, description: '路由组 ID', schema: new OA\Schema(type: 'integer')),
],
@@ -331,7 +331,7 @@ class RouteGroupController extends AbstractController
summary: '删除路由组',
description: '删除路由组,组内路由 group_id 自动设为 NULLrole_route_groups 关联自动级联删除',
security: [['bearerAuth' => []]],
tags: ['RouteGroups'],
tags: ['Route Groups'],
parameters: [
new OA\Parameter(name: 'id', in: 'path', required: true, description: '路由组 ID', schema: new OA\Schema(type: 'integer')),
],
@@ -380,7 +380,7 @@ class RouteGroupController extends AbstractController
summary: '路由列表',
description: '获取全部路由列表,含分组信息,支持按 group_id、method、path 筛选',
security: [['bearerAuth' => []]],
tags: ['RouteGroups'],
tags: ['Route Groups'],
parameters: [
new OA\Parameter(name: 'group_id', in: 'query', required: false, description: '路由组 ID,传 0 或 "ungrouped" 筛选未分组路由', schema: new OA\Schema(type: 'string')),
new OA\Parameter(name: 'method', in: 'query', required: false, description: 'HTTP 方法筛选', schema: new OA\Schema(type: 'string')),
@@ -460,7 +460,7 @@ class RouteGroupController extends AbstractController
summary: '分配路由到路由组',
description: '将路由分配到指定路由组,传 group_id=null 表示从分组中移出',
security: [['bearerAuth' => []]],
tags: ['RouteGroups'],
tags: ['Route Groups'],
parameters: [
new OA\Parameter(name: 'id', in: 'path', required: true, description: '路由 ID', schema: new OA\Schema(type: 'integer')),
],