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
@@ -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')),
],