增加了api文档

This commit is contained in:
xrain committed 2026-09-01 18:17:37 +08:00
1 parent e0e57a7eb4
commit 73e770db80
25 files changed
+913 -140

No files matched your search

@@ -6,16 +6,16 @@
* This source file is licensed under the MIT License found in the
* LICENSE file in the root directory of this source tree.
*/
package simcu::simapi.openapi.metadata
/**
* @brief 提供 API 分组名称元数据。
* @brief 提供 API 多分组名称元数据(逗号分隔,如 "api,admin")。
*/
public interface IApiGroupNameProvider {
public interface IApiGroupNamesProvider {
/**
* @brief 返回 API 分组名称。
* @return 当前 API 的分组名称。
* @brief 返回 API 所属的多个分组名称(逗号分隔)。
* @return 逗号分隔的分组名称字符串,空串表示未指定。
*/
prop groupName: ?String
}
prop groupNames: String
}
@@ -0,0 +1,18 @@
/*
* Copyright (c) 2025 SimCuTeam. All rights reserved.
* 遵循 MIT 许可证。
*/
package simcu::simapi.openapi.metadata
import std.reflect.*
/**
* @brief 提供 API 响应类型元数据(供动态注册的路由指定返回类型)。
*/
public interface IApiResponseTypeMetadata {
/**
* @brief 返回 API 响应的类型信息。
*/
prop responseType: ?TypeInfo
}