接口添加注释
This commit is contained in:
parent
13346252b0
commit
23cdd335ab
@ -34,6 +34,7 @@ public class AppUserService : BaseService<AppUserEntity>, ITransient
|
||||
/// </summary>
|
||||
/// <param name="input"></param>
|
||||
/// <returns></returns>
|
||||
[DisplayName("分页查询普通用户")]
|
||||
[HttpGet("page")]
|
||||
public async Task<PageResult<AppUserOutput>> Page([FromQuery] AppUserPageInput input)
|
||||
{
|
||||
@ -55,6 +56,7 @@ public class AppUserService : BaseService<AppUserEntity>, ITransient
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <returns></returns>
|
||||
[DisplayName("获取普通用户详情")]
|
||||
[HttpGet("{id}")]
|
||||
public async Task<AppUserOutput> Detail([FromRoute] long id)
|
||||
{
|
||||
@ -69,6 +71,7 @@ public class AppUserService : BaseService<AppUserEntity>, ITransient
|
||||
/// </summary>
|
||||
/// <param name="input"></param>
|
||||
/// <returns></returns>
|
||||
[DisplayName("审核普通用户")]
|
||||
[HttpPost("audit")]
|
||||
[UnitOfWork]
|
||||
public async Task Audit([FromBody] AuditInput input)
|
||||
@ -125,6 +128,7 @@ public class AppUserService : BaseService<AppUserEntity>, ITransient
|
||||
/// </summary>
|
||||
/// <param name="input"></param>
|
||||
/// <returns></returns>
|
||||
[DisplayName("领队列表查询")]
|
||||
[HttpGet("leader/page")]
|
||||
public async Task<PageResult<AppUserEntity>> LeaderPage([FromQuery] TeamMemberQueryInput input)
|
||||
{
|
||||
@ -136,6 +140,7 @@ public class AppUserService : BaseService<AppUserEntity>, ITransient
|
||||
/// </summary>
|
||||
/// <param name="input"></param>
|
||||
/// <returns></returns>
|
||||
[DisplayName("教练列表查询")]
|
||||
[HttpGet("coach/page")]
|
||||
public async Task<PageResult<AppUserEntity>> CoachPage([FromQuery] TeamMemberQueryInput input)
|
||||
{
|
||||
@ -220,6 +225,7 @@ public class AppUserService : BaseService<AppUserEntity>, ITransient
|
||||
/// </summary>
|
||||
/// <param name="input"></param>
|
||||
/// <returns></returns>
|
||||
[DisplayName("新增/编辑领队")]
|
||||
[HttpPost("leader/save")]
|
||||
public async Task SaveLeader(CreateOrUpdateMemberInput input)
|
||||
{
|
||||
@ -231,6 +237,7 @@ public class AppUserService : BaseService<AppUserEntity>, ITransient
|
||||
/// </summary>
|
||||
/// <param name="input"></param>
|
||||
/// <returns></returns>
|
||||
[DisplayName("新增/编辑教练")]
|
||||
[HttpPost("coach/save")]
|
||||
public async Task SaveCoach(CreateOrUpdateMemberInput input)
|
||||
{
|
||||
@ -242,6 +249,7 @@ public class AppUserService : BaseService<AppUserEntity>, ITransient
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <returns></returns>
|
||||
[DisplayName("删除成员")]
|
||||
[HttpPost("member/delete")]
|
||||
public async Task DeleteMember([FromBody] long id)
|
||||
{
|
||||
@ -262,6 +270,7 @@ public class AppUserService : BaseService<AppUserEntity>, ITransient
|
||||
/// </summary>
|
||||
/// <param name="input"></param>
|
||||
/// <returns></returns>
|
||||
[DisplayName("变更成员状态")]
|
||||
[HttpPost("member/status")]
|
||||
public async Task ChangeMemberStatus(ChangeMemberStatusInput input)
|
||||
{
|
||||
|
||||
@ -31,6 +31,7 @@ public class AuthService : IDynamicApiController
|
||||
/// </summary>
|
||||
/// <param name="dto"></param>
|
||||
/// <returns></returns>
|
||||
[DisplayName("系统用户登录")]
|
||||
[HttpPost]
|
||||
public async Task SignIn(AdminLoginInput dto)
|
||||
{
|
||||
@ -85,6 +86,7 @@ public class AuthService : IDynamicApiController
|
||||
/// </summary>
|
||||
/// <param name="id">验证码唯一id</param>
|
||||
/// <returns></returns>
|
||||
[DisplayName("获取验证码")]
|
||||
[HttpGet]
|
||||
public IActionResult Captcha([FromQuery] string id)
|
||||
{
|
||||
|
||||
@ -71,6 +71,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 1. 赛事列表展示接口
|
||||
/// </summary>
|
||||
[DisplayName("赛事列表展示")]
|
||||
[HttpGet("list")]
|
||||
public async Task<PageResult<UserEventListOutput>> Page([FromQuery] UserEventQueryInput input)
|
||||
{
|
||||
@ -99,6 +100,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 2. 赛事详情查看接口
|
||||
/// </summary>
|
||||
[DisplayName("赛事详情查看")]
|
||||
[HttpGet("detail/{id}")]
|
||||
public async Task<UserEventDetailOutput> Detail([FromRoute] long id)
|
||||
{
|
||||
@ -172,6 +174,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 3.1 选择报名项目接口
|
||||
/// </summary>
|
||||
[DisplayName("选择报名项目")]
|
||||
[HttpGet("projects/{eventId}")]
|
||||
public async Task<List<UserEventProjectListOutput>> GetProjects([FromRoute] long eventId)
|
||||
{
|
||||
@ -190,6 +193,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 3.2 分配队员接口 - 搜索队员
|
||||
/// </summary>
|
||||
[DisplayName("搜索队员")]
|
||||
[HttpGet("members/search")]
|
||||
public async Task<List<UserTeamMemberOutput>> SearchMembers([FromQuery] string keyword)
|
||||
{
|
||||
@ -221,6 +225,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 3.2 分配队员接口 - 提交报名(含保存草稿)
|
||||
/// </summary>
|
||||
[DisplayName("提交报名")]
|
||||
[HttpPost("submit")]
|
||||
[UnitOfWork]
|
||||
public async Task<long> SubmitRegistration([FromBody] UserSubmitRegistrationInput input)
|
||||
@ -321,6 +326,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 3.3 预览支付接口
|
||||
/// </summary>
|
||||
[DisplayName("预览支付")]
|
||||
[HttpGet("preview/{registrationId}")]
|
||||
public async Task<UserOrderPreviewOutput> PreviewOrder([FromRoute] long registrationId)
|
||||
{
|
||||
@ -361,6 +367,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 创建支付订单
|
||||
/// </summary>
|
||||
[DisplayName("创建支付订单")]
|
||||
[HttpPost("order/create")]
|
||||
[UnitOfWork]
|
||||
public async Task<UserPaymentResultOutput> CreateOrder([FromBody] UserCreateOrderInput input)
|
||||
@ -387,6 +394,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 1. 列表查询
|
||||
/// </summary>
|
||||
[DisplayName("参赛记录列表查询")]
|
||||
[HttpGet("/event/pc/registration/list")]
|
||||
[Authorize(Roles = "PC_USER")]
|
||||
public async Task<PageResult<RegistrationItemDTO>> GetRegistrationList([FromQuery] RegistrationListQueryInput input)
|
||||
@ -486,6 +494,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 2. 取消报名
|
||||
/// </summary>
|
||||
[DisplayName("取消报名")]
|
||||
[HttpPut("/event/pc/registration/{registrationId}/cancel")]
|
||||
[Authorize(Roles = "PC_USER")]
|
||||
[UnitOfWork]
|
||||
@ -535,6 +544,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 3. 上传素材
|
||||
/// </summary>
|
||||
[DisplayName("上传素材")]
|
||||
[HttpPost("/event/pc/registration/{registrationId}/material")]
|
||||
[Authorize(Roles = "PC_USER")]
|
||||
[UnitOfWork]
|
||||
@ -594,6 +604,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 4. 上传付款凭证
|
||||
/// </summary>
|
||||
[DisplayName("上传付款凭证")]
|
||||
[HttpPost("/event/pc/registration/{registrationId}/voucher")]
|
||||
[Authorize(Roles = "PC_USER")]
|
||||
[UnitOfWork]
|
||||
@ -642,6 +653,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 5.1 查看队员列表
|
||||
/// </summary>
|
||||
[DisplayName("查看队员列表")]
|
||||
[HttpGet("/event/pc/registration/{registrationId}/member")]
|
||||
[Authorize(Roles = "PC_USER")]
|
||||
public async Task<List<TeamMemberDTO>> GetTeamMembers([FromRoute] long registrationId)
|
||||
@ -669,6 +681,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 5.2 更换队员
|
||||
/// </summary>
|
||||
[DisplayName("更换队员")]
|
||||
[HttpPut("/event/pc/registration/{registrationId}/member/{userId}/replace")]
|
||||
[Authorize(Roles = "PC_USER")]
|
||||
[UnitOfWork]
|
||||
@ -720,6 +733,7 @@ public class UserCompetitionService : IDynamicApiController, ITransient
|
||||
/// <summary>
|
||||
/// 6. 查看证书
|
||||
/// </summary>
|
||||
[DisplayName("查看证书")]
|
||||
[HttpGet("/event/pc/registration/{registrationId}/certificate")]
|
||||
[Authorize(Roles = "PC_USER")]
|
||||
public async Task<ResponseDTO<CertificateDTO>> GetCertificate([FromRoute] long registrationId)
|
||||
|
||||
@ -191,6 +191,7 @@ public class MerchantService : BaseService<YD_Event.Core.Entities.Merchant>, ITr
|
||||
/// <summary>
|
||||
/// 审核商户
|
||||
/// </summary>
|
||||
[DisplayName("审核商户")]
|
||||
[HttpPost("audit")]
|
||||
[UnitOfWork]
|
||||
public async Task Audit([FromBody] MerchantAuditInput input)
|
||||
@ -209,6 +210,7 @@ public class MerchantService : BaseService<YD_Event.Core.Entities.Merchant>, ITr
|
||||
/// <summary>
|
||||
/// 发放优惠券
|
||||
/// </summary>
|
||||
[DisplayName("发放优惠券")]
|
||||
[HttpPost("issueCoupon")]
|
||||
[UnitOfWork]
|
||||
public async Task IssueCoupon([FromBody] IssueCouponInput input)
|
||||
|
||||
@ -206,6 +206,7 @@ public class SysUserService : BaseService<SysUser>, ITransient
|
||||
/// </summary>
|
||||
/// <param name="id"></param>
|
||||
/// <returns></returns>
|
||||
[DisplayName("系统用户详情")]
|
||||
[HttpGet("detail")]
|
||||
public async Task<UpdateSysUserInput> Detail([FromQuery] long id)
|
||||
{
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
using SqlSugar;
|
||||
using SqlSugar;
|
||||
using YD_Event.Core.Enum;
|
||||
|
||||
namespace YD_Event.Core.Entities;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user