From 4783a3eae089aeee877628d33a6dbb5f73b83d29 Mon Sep 17 00:00:00 2001 From: chr_ Date: Sat, 11 Jan 2025 10:21:51 +0800 Subject: [PATCH] =?UTF-8?q?misc=20=E9=80=82=E9=85=8D=E6=96=B0=E7=9A=84IPC?= =?UTF-8?q?=20Attribute?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ASFEnhance/ASFEnhance.csproj | 3 +-- ASFEnhance/IPC/Controllers/ASFEController.cs | 3 +-- .../IPC/Controllers/CuratorController.cs | 12 +++++++----- .../IPC/Controllers/PurchaseController.cs | 18 +++++++++++------- .../IPC/Controllers/RecommendController.cs | 8 +++++--- .../IPC/Controllers/WishlistController.cs | 17 +++++++++++------ Directory.Build.props | 2 +- 7 files changed, 37 insertions(+), 26 deletions(-) diff --git a/ASFEnhance/ASFEnhance.csproj b/ASFEnhance/ASFEnhance.csproj index 72720075..e6448acf 100644 --- a/ASFEnhance/ASFEnhance.csproj +++ b/ASFEnhance/ASFEnhance.csproj @@ -1,4 +1,4 @@ - + Library @@ -10,7 +10,6 @@ - diff --git a/ASFEnhance/IPC/Controllers/ASFEController.cs b/ASFEnhance/IPC/Controllers/ASFEController.cs index a76143c9..3f5b1825 100644 --- a/ASFEnhance/IPC/Controllers/ASFEController.cs +++ b/ASFEnhance/IPC/Controllers/ASFEController.cs @@ -1,6 +1,6 @@ using ArchiSteamFarm.IPC.Controllers.Api; using Microsoft.AspNetCore.Mvc; -using Swashbuckle.AspNetCore.Annotations; +using Microsoft.AspNetCore.Routing; namespace ASFEnhance.IPC.Controllers; @@ -8,5 +8,4 @@ namespace ASFEnhance.IPC.Controllers; /// 基础控制器 /// [Route("/Api/[controller]/[action]")] -[SwaggerTag(nameof(ASFEnhance))] public abstract class ASFEController : ArchiController { } diff --git a/ASFEnhance/IPC/Controllers/CuratorController.cs b/ASFEnhance/IPC/Controllers/CuratorController.cs index 09973206..2e33e526 100644 --- a/ASFEnhance/IPC/Controllers/CuratorController.cs +++ b/ASFEnhance/IPC/Controllers/CuratorController.cs @@ -5,8 +5,8 @@ using ASFEnhance.Data; using ASFEnhance.IPC.Requests; using ASFEnhance.IPC.Responses; +using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; -using Swashbuckle.AspNetCore.Annotations; using System.Globalization; using System.Net; @@ -25,8 +25,8 @@ public sealed class CuratorController : ASFEController /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "关注鉴赏家", Description = "需要指定ClanId")] - [SwaggerResponse((int)HttpStatusCode.BadRequest, $"The request has failed, check {nameof(GenericResponse.Message)} from response body for actual reason. Most of the time this is ASF, understanding the request, but refusing to execute it due to provided reason.", typeof(GenericResponse))] + [EndpointDescription("需要指定ClanId")] + [EndpointSummary("关注鉴赏家")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> FollowCurator(string botNames, [FromBody] ClanIdListRequest request) @@ -84,7 +84,8 @@ public async Task> FollowCurator(string botNames, /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "取消关注鉴赏家", Description = "需要指定ClanId")] + [EndpointDescription("需要指定ClanId")] + [EndpointSummary("取消关注鉴赏家")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> UnFollowCurator(string botNames, [FromBody] ClanIdListRequest request) @@ -143,7 +144,8 @@ public async Task> UnFollowCurator(string botNames /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "获取已关注的鉴赏家列表", Description = "Start:起始位置,Count:获取数量")] + [EndpointDescription("Start:起始位置,Count:获取数量")] + [EndpointSummary("获取已关注的鉴赏家列表")] [ProducesResponseType(typeof(GenericResponse>>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> FollowingCurators(string botNames, [FromBody] CuratorsRequest request) diff --git a/ASFEnhance/IPC/Controllers/PurchaseController.cs b/ASFEnhance/IPC/Controllers/PurchaseController.cs index 80962015..7b70e421 100644 --- a/ASFEnhance/IPC/Controllers/PurchaseController.cs +++ b/ASFEnhance/IPC/Controllers/PurchaseController.cs @@ -2,15 +2,14 @@ using ArchiSteamFarm.IPC.Responses; using ArchiSteamFarm.Localization; using ArchiSteamFarm.Steam; -using ASFEnhance.Cart; using ASFEnhance.Data.Common; using ASFEnhance.Data.IAccountCartService; using ASFEnhance.Data.Plugin; using ASFEnhance.IPC.Requests; using ASFEnhance.IPC.Responses; using ASFEnhance.Store; +using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; -using Swashbuckle.AspNetCore.Annotations; using System.Data; using System.Globalization; using System.Net; @@ -31,7 +30,8 @@ public sealed class PurchaseController : ASFEController /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "获取游戏详情", Description = "需要指定AppIds列表")] + [EndpointDescription("需要指定AppIds列表")] + [EndpointSummary("获取游戏详情")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> GetAppDetail(string botNames, [FromBody] AppIdListRequest request) @@ -154,7 +154,8 @@ public async Task> GetAppDetail(string botNames, [ /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "清空购物车", Description = "清除购物车所有内容")] + [EndpointDescription("清除购物车所有内容")] + [EndpointSummary("清空购物车")] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> ClearCart(string botNames) @@ -200,7 +201,8 @@ public async Task> ClearCart(string botNames) /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "读取机器人购物车", Description = "读取机器人购物车内容")] + [EndpointDescription("读取机器人购物车内容")] + [EndpointSummary("读取机器人购物车")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> GetCart(string botNames) @@ -316,7 +318,8 @@ public async Task> GetCart(string botNames) /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "购物车添加项目", Description = "IsGift为True时需要定义GiftInfo")] + [EndpointDescription("IsGift为True时需要定义GiftInfo")] + [EndpointSummary("购物车添加项目")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> AddCart(string botNames, [FromBody] AddCartRequest request) @@ -482,7 +485,8 @@ public async Task> AddCart(string botNames, [FromB /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "购物车下单", Description = "结算当前购物车")] + [EndpointDescription("结算当前购物车")] + [EndpointSummary("购物车下单")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> Purchase(string botNames, [FromBody] OnlyPurchaseRequest request) diff --git a/ASFEnhance/IPC/Controllers/RecommendController.cs b/ASFEnhance/IPC/Controllers/RecommendController.cs index 5509dcd8..faf16413 100644 --- a/ASFEnhance/IPC/Controllers/RecommendController.cs +++ b/ASFEnhance/IPC/Controllers/RecommendController.cs @@ -4,8 +4,8 @@ using ArchiSteamFarm.Steam; using ASFEnhance.IPC.Requests; using ASFEnhance.IPC.Responses; +using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; -using Swashbuckle.AspNetCore.Annotations; using System.Globalization; using System.Net; @@ -24,7 +24,8 @@ public sealed class RecommendController : ASFEController /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "发布游戏评测", Description = "RateUp:true好评,AllowReply:true允许回复,ForFree:false非免费取得,Public:true评测公开可见,Comment:评测内容")] + [EndpointDescription("RateUp:true好评,AllowReply:true允许回复,ForFree:false非免费取得,Public:true评测公开可见,Comment:评测内容")] + [EndpointSummary("发布游戏评测")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> PublishReview(string botNames, [FromBody] RecommendRequest request) @@ -92,7 +93,8 @@ public async Task> PublishReview(string botNames, /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "删除游戏评测", Description = "需要指定AppIds列表")] + [EndpointDescription("需要指定AppIds列表")] + [EndpointSummary("删除游戏评测")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> DeleteReview(string botNames, [FromBody] AppIdListRequest request) diff --git a/ASFEnhance/IPC/Controllers/WishlistController.cs b/ASFEnhance/IPC/Controllers/WishlistController.cs index e8dd2b99..29200abc 100644 --- a/ASFEnhance/IPC/Controllers/WishlistController.cs +++ b/ASFEnhance/IPC/Controllers/WishlistController.cs @@ -4,8 +4,8 @@ using ArchiSteamFarm.Steam; using ASFEnhance.IPC.Requests; using ASFEnhance.IPC.Responses; +using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; -using Swashbuckle.AspNetCore.Annotations; using System.Globalization; using System.Net; @@ -24,7 +24,8 @@ public sealed class WishlistController : ASFEController /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "添加愿望单", Description = "需要指定AppIds列表")] + [EndpointDescription("需要指定AppIds列表")] + [EndpointSummary("添加愿望单")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> AddWishlist(string botNames, [FromBody] AppIdListRequest request) @@ -84,7 +85,8 @@ public async Task> AddWishlist(string botNames, [F /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "移除愿望单", Description = "需要指定AppIds列表")] + [EndpointDescription("需要指定AppIds列表")] + [EndpointSummary("移除愿望单")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> RemoveWishlist(string botNames, [FromBody] AppIdListRequest request) @@ -144,7 +146,8 @@ public async Task> RemoveWishlist(string botNames, /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "关注游戏", Description = "需要指定AppIds列表")] + [EndpointDescription("需要指定AppIds列表")] + [EndpointSummary("关注游戏")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> FollowGame(string botNames, [FromBody] AppIdListRequest request) @@ -204,7 +207,8 @@ public async Task> FollowGame(string botNames, [Fr /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "取消关注游戏", Description = "需要指定AppIds列表")] + [EndpointDescription("需要指定AppIds列表")] + [EndpointSummary("取消关注游戏")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> UnFollowGame(string botNames, [FromBody] AppIdListRequest request) @@ -264,7 +268,8 @@ public async Task> UnFollowGame(string botNames, [ /// /// [HttpPost("{botNames:required}")] - [SwaggerOperation(Summary = "检查游戏关注/愿望单情况", Description = "需要指定AppIds列表")] + [EndpointDescription("需要指定AppIds列表")] + [EndpointSummary("检查游戏关注/愿望单情况")] [ProducesResponseType(typeof(GenericResponse>), (int)HttpStatusCode.OK)] [ProducesResponseType(typeof(GenericResponse), (int)HttpStatusCode.BadRequest)] public async Task> CheckGame(string botNames, [FromBody] AppIdListRequest request) diff --git a/Directory.Build.props b/Directory.Build.props index 7a29fb28..1918fe50 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -1,6 +1,6 @@ - 2.3.3.0 + 2.3.4.0