move common controller to api group

.github/workflows/main.yml

@@ -3,20 +3,7 @@ name: PublishNugetPackage
 on: [create]
 
 jobs:
-  build:
-    name: Build Project
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: Setup .NET Core
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: '3.1.101'
-    - name: Build
-      run: dotnet build
-  
   publish:
-    needs: build
     name: Publish Project to Nuget
     runs-on: ubuntu-latest
     steps:
@@ -24,11 +11,11 @@ jobs:
     - name: Setup .NET Core
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: '3.1.101'
+        dotnet-version: '5.0.100'
     - name: Publish
       run: |
         version=`git describe --tags`
-        dotnet pack --configuration release -p:PackageVersion=$version
+        dotnet build --configuration release -p:PackageVersion=$version
         dotnet nuget push bin/release/Simcu.SimApi.$version.nupkg -k ${NUGET_APIKEY} -s https://www.nuget.org/api/v2/package
       env:
         NUGET_APIKEY: ${{ secrets.NUGET_APIKEY }}

Attributes/SimApiAuthAttribute.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Linq;
+using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
 using SimApi.Communications;
 using SimApi.Exceptions;
@@ -14,6 +15,7 @@ namespace SimApi.Attributes
     {
         private string[] Types { get; }
 
+
         //默认是user登录类型
         public SimApiAuthAttribute()
         {
@@ -32,6 +34,13 @@ namespace SimApi.Attributes
             Types = types;
         }
 
+        //只检测一种用户类型的快捷方式
+        public SimApiAuthAttribute(string type, string url)
+        {
+            Types = new[] { type };
+            new HttpPostAttribute(url);
+        }
+
         public override void OnActionExecuting(ActionExecutingContext context)
         {
             var loginInfo = (SimApiLoginItem)context.HttpContext.Items["LoginInfo"];

Communications/SimApiBaseResponse.cs

@@ -95,7 +95,7 @@ namespace SimApi.Communications
             {
                 IgnoreReadOnlyProperties = true,
                 PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
-                Converters = { new JsonStringEnumConverter() }
+                Converters = {new JsonStringEnumConverter()}
             });
         }
     }
@@ -110,10 +110,13 @@ namespace SimApi.Communications
         /// 动态内容列表
         /// </summary>
         public T List { get; set; }
+
         //当前页码
         public int Page { get; set; }
+
         //每页条数
         public int Count { get; set; }
+
         //总计条数
         public int Total { get; set; }
     }

Controllers/SimApiBaseController.cs

@@ -47,7 +47,7 @@ namespace SimApi.Controllers
         /// <param name="code">错误代码</param>
         /// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
         /// <returns></returns>
-        protected static void Error(int code = 500, string message = "服务器错误")
+        protected static void Error(int code = 500, string message = "")
         {
             throw new SimApiException(code, message);
         }
@@ -58,7 +58,7 @@ namespace SimApi.Controllers
         /// <param name="condition">检测条件</param>
         /// <param name="code">错误代码</param>
         /// <param name="message">错误描述</param>
-        protected static void ErrorWhen(bool condition, int code = 500, string message = "服务器错误")
+        protected static void ErrorWhen(bool condition, int code = 500, string message = "")
         {
             if (condition)
             {
@@ -72,7 +72,7 @@ namespace SimApi.Controllers
         /// <param name="condition">检测条件</param>
         /// <param name="code">错误代码</param>
         /// <param name="message">错误描述</param>
-        protected static void ErrorWhenNull(object condition, int code = 404, string message = "资源不存在")
+        protected static void ErrorWhenNull(object condition, int code = 404, string message = "")
         {
             ErrorWhen(condition == null, code, message);
         }

Controllers/SimApiCommonController.cs

@@ -6,6 +6,7 @@ using SimApi.Helpers;
 
 namespace SimApi.Controllers
 {
+    [ApiExplorerSettings(GroupName = "api")]
     public class YYCommonController : SimApiBaseController
     {
         private SimApiAuth Auth { get; }
@@ -37,7 +38,7 @@ namespace SimApi.Controllers
         public SimApiBaseResponse<int> CheckLogin()
         {
             ErrorWhenNull(LoginInfo, 401);
-            return new SimApiBaseResponse<int> { Data = LoginInfo.Id };
+            return new SimApiBaseResponse<int> {Data = LoginInfo.Id};
         }
 
         /// <summary>
@@ -53,8 +54,9 @@ namespace SimApi.Controllers
             {
                 token = Request.Headers["Token"];
             }
+
             Auth.Logout(token);
             return new SimApiBaseResponse();
         }
     }
-}
+}

Middlewares/SimApiExceptionMiddleware.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Http;
 using SimApi.Communications;
@@ -32,6 +33,13 @@ namespace SimApi.Middlewares
             try
             {
                 await Next(context);
+                if (context.Response.StatusCode != 200)
+                {
+                    if (!new[] {301, 302}.Contains(context.Response.StatusCode))
+                    {
+                        throw new SimApiException(context.Response.StatusCode);
+                    }
+                }
             }
             catch (SimApiException ex)
             {
@@ -43,6 +51,7 @@ namespace SimApi.Middlewares
                 {
                     response.SetCodeMsg(ex.Code, ex.Message);
                 }
+
                 ErrorResponse(context, response);
             }
             catch (Exception ex)

README.md

@@ -1,4 +1,4 @@
-# YYApi 基于Asp.net Core 3的一个基础辅助包
+# YYApi 基于Asp.net Core 3/5的一个基础辅助包
 
 ![CI](https://github.com/YY-Tech/YYApi/workflows/CI/badge.svg)
 

SimApi.csproj

@@ -1,7 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
     <OutputType>Library</OutputType>
     <PackOnBuild>true</PackOnBuild>
     <Version>0.2.3</Version>
@@ -11,10 +10,14 @@
     <IsPackable>true</IsPackable>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <IncludeSymbols>true</IncludeSymbols>
-    <ReleaseVersion>1.1.1</ReleaseVersion>
+    <ReleaseVersion>5.0.0</ReleaseVersion>
     <SynchReleaseVersion>false</SynchReleaseVersion>
+    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <PackageVersion>5.0.2</PackageVersion>
+    <TargetFrameworks>net5.0;netcoreapp3.1</TargetFrameworks>
   </PropertyGroup>
 
+  <PropertyGroup Condition=" '$(RunConfiguration)' == 'YYApi' " />
   <ItemGroup>
     <Folder Include="Helpers\" />
     <Folder Include="Communications\" />
@@ -24,8 +27,8 @@
     <Folder Include="Exceptions\" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="5.5.1" />
-    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="5.5.1" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="5.6.3" />
+    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="5.6.3" />
   </ItemGroup>
   <ProjectExtensions>
     <MonoDevelop>

SimApiExtensions.cs

@@ -5,6 +5,7 @@ using Microsoft.Extensions.DependencyInjection;
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.SwaggerUI;
 using SimApi.Middlewares;
+using Microsoft.AspNetCore.HttpOverrides;
 
 namespace SimApi
 {
@@ -28,7 +29,16 @@ namespace SimApi
         public static IServiceCollection AddSimApi(this IServiceCollection builder, string title,
             string description = null)
         {
-            return builder.AddSimApiAuth().AddSimApiDoc(title, description).AddCors().AddSimApiUpload();
+            return builder.AddSimApiAuth().AddSimApiDoc(title, description).AddCors().AddSimApiUpload().Configure<ForwardedHeadersOptions>(options =>
+            {
+                options.ForwardedHeaders = ForwardedHeaders.XForwardedFor |
+                    ForwardedHeaders.XForwardedProto;
+                // Only loopback proxies are allowed by default.
+                // Clear that restriction because forwarders are enabled by explicit 
+                // configuration.
+                options.KnownNetworks.Clear();
+                options.KnownProxies.Clear();
+            }); ;
         }
 
         /// <summary>
@@ -41,7 +51,7 @@ namespace SimApi
         /// <returns></returns>
         public static IApplicationBuilder UseSimApi(this IApplicationBuilder builder, params SubmitMethod[] submitMethods)
         {
-            return builder.UseSimApiException().UseSimApiDoc(submitMethods).UseMiddleware<SimApiAuthMiddleware>().UseCors(x => x.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin()).UseSimApiUpload();
+            return builder.UseSimApiException().UseSimApiDoc(submitMethods).UseMiddleware<SimApiAuthMiddleware>().UseCors(x => x.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin()).UseSimApiUpload().UseForwardedHeaders();
         }