update api doc
This commit is contained in:
@@ -14,7 +14,7 @@ use Hyperf\HttpServer\Annotation\RequestMapping;
|
||||
use OpenApi\Attributes as OA;
|
||||
use Qbhy\HyperfAuth\AuthManager;
|
||||
|
||||
#[OA\Tag(name: 'ApiKeys', description: 'API Key 管理')]
|
||||
#[OA\Tag(name: 'API Keys', description: 'API Key 管理')]
|
||||
#[Controller(prefix: "/api/v1/me/api-keys")]
|
||||
class ApiKeyController extends AbstractController
|
||||
{
|
||||
@@ -28,7 +28,7 @@ class ApiKeyController extends AbstractController
|
||||
summary: '生成 API Key',
|
||||
description: '生成新的 API Key,需用户已启用 api_key_enabled。明文仅在生成时返回一次',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['ApiKeys'],
|
||||
tags: ['API Keys'],
|
||||
requestBody: new OA\RequestBody(
|
||||
required: true,
|
||||
content: new OA\JsonContent(
|
||||
@@ -138,7 +138,7 @@ class ApiKeyController extends AbstractController
|
||||
summary: 'API Key 列表',
|
||||
description: '列出当前用户的所有 API Keys',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['ApiKeys'],
|
||||
tags: ['API Keys'],
|
||||
responses: [
|
||||
new OA\Response(
|
||||
response: 200,
|
||||
@@ -192,7 +192,7 @@ class ApiKeyController extends AbstractController
|
||||
path: '/me/api-keys/{id}',
|
||||
summary: '删除 API Key',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['ApiKeys'],
|
||||
tags: ['API Keys'],
|
||||
parameters: [
|
||||
new OA\Parameter(name: 'id', in: 'path', required: true, description: 'API Key ID', schema: new OA\Schema(type: 'integer')),
|
||||
],
|
||||
|
||||
@@ -23,7 +23,7 @@ use Hyperf\HttpServer\Annotation\RequestMapping;
|
||||
use OpenApi\Attributes as OA;
|
||||
use Psr\Http\Message\ResponseInterface;
|
||||
|
||||
#[OA\Tag(name: 'DataScope', description: '用户数据范围管理')]
|
||||
#[OA\Tag(name: 'Data Scope', description: '用户数据范围管理')]
|
||||
#[Controller(prefix: "/api/v1/users")]
|
||||
class DataScopeController extends AbstractController
|
||||
{
|
||||
@@ -45,7 +45,7 @@ class DataScopeController extends AbstractController
|
||||
summary: '查看用户数据权限',
|
||||
description: '返回用户的 scope 列表(含实体名称)和解析后的 store_ids',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['DataScope'],
|
||||
tags: ['Data Scope'],
|
||||
parameters: [
|
||||
new OA\Parameter(name: 'id', in: 'path', required: true, description: '用户 ID', schema: new OA\Schema(type: 'integer')),
|
||||
],
|
||||
@@ -126,7 +126,7 @@ class DataScopeController extends AbstractController
|
||||
summary: '设置用户数据权限',
|
||||
description: '全量替换用户的 scope 绑定,并重建 bitmap',
|
||||
security: [['bearerAuth' => []]],
|
||||
tags: ['DataScope'],
|
||||
tags: ['Data Scope'],
|
||||
parameters: [
|
||||
new OA\Parameter(name: 'id', in: 'path', required: true, description: '用户 ID', schema: new OA\Schema(type: 'integer')),
|
||||
],
|
||||
|
||||
@@ -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 自动设为 NULL,role_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')),
|
||||
],
|
||||
|
||||
Reference in New Issue
Block a user