📄️ summary
简介
📄️ install
安装
📄️ config
配置
📄️ @ApiStart
@ApiStart
📄️ @Api
用来指定请求方法和请求路径，用法：@Api 请求方法 请求路径。
📄️ @Version
表示当前api的版本，用法：@Version 1.0.0。不设置此字段，默认api版本为1.0.0。
📄️ @Group
用来标识当前api所属的群组，用法：@Group 组名称，不设置此字段，默认群组为default。相同组名称的api将组织在一起。
📄️ @Name
标识api的名称，此属性必须设置。在同一group群组内，name属性需唯一。 用法：@Name 名称 api的简短描述。
📄️ @Description
对当前api的详细描述，用法：@Description 描述内容，描述内容可以分多行。
📄️ @HeaderParam
设置请求头部参数，用法：`@HeaderParam 字段类型 字段名称 字段的相关描述`。可以设置多条请求头部参数。
📄️ @UrlParam
请求路径中的参数，搭配`@Api`使用， 用法：`@UrlParam 字段类型 字段名称 字段的相关描述`。
📄️ @QueryParam
查询参数设置，用法：`@QueryParam 字段类型 字段名称 字段的相关描述`。
📄️ @BodyParam
请求体参数设置，用法：`@BodyParam 字段类型 字段名称 字段的相关描述`。该设置仅在Post、Put、Patch等方法下生效。
📄️ @ContentType
该设置仅在Post、Put、Patch等方法下生效，用来定义传参方式，以便后台做对应的解析，用法：`@ContentType 类型`。 不设置ContentType默认为application/json
📄️ @Deprecated
标识当前接口弃用，用法：` @Deprecated 弃用说明 `。 在弃用说明里面，若包含` (ReplaceWith:Group#Name) `,将会生成一个连接,点击直接跳到替代接口。` Grpup `是替代接口所属的群组，` Name `为替代接口的名称
📄️ @SuccessResponse
指定接口成功返回的示例数据，用法：`@SuccessResponse 返回类型 返回状态码 其他说明`。
📄️ @ErrorResponse
指定接口失败返回的示例数据，用法：`@ErrorResponse 返回类型 返回状态码 其他说明`。
📄️ @Define&@Reuse
// 定义复用模块ReuseItem
📄️ @TryRequest
开启当前接口调试，用法：`@TryRequest true/false`。 不设置此标志位，默认开启调试功能，当设置成false时，则禁用接口调试功能。
📄️ @Model
// 自定义类型personModel