sw描述文件

QYMessageCenter/.config/dotnet-tools.json

@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "dotnet-ef": {
+      "version": "8.0.2",
+      "commands": [
+        "dotnet-ef"
+      ]
+    }
+  }
+}

QYMessageCenter/Controllers/MessageController.cs

@@ -1,5 +1,4 @@
-using Microsoft.AspNetCore.Http;
-using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc;
 using QYMessageCenter.Business;
 using QYMessageCenter.Model.DTO;
 

QYMessageCenter/Program.cs

@@ -10,6 +10,7 @@ using QYMessageCenter.Filters;
 using QYMessageCenter.Middlewares;
 using QYMessageCenter.Model;
 using System.Reflection;
+using System.Text;
 using Yitter.IdGenerator;
 
 var builder = WebApplication.CreateBuilder(args);
@@ -60,7 +61,7 @@ services.AddSwaggerGen(c =>
     {
         Version = "v1.0.0",
         Title = "齐越消息中心API",
-        Description = "注意事项\r\n1.返回参数名称采用大驼峰命名\r\n2.ApiResponse为基础返回对象(Code,Data,Message),接口中所有的返回值均属于Data属性\r\n3.正常返回Code=200"
+        Description = getSWDescription()
     });
     //JWT认证
     c.AddSecurityDefinition(JwtBearerDefaults.AuthenticationScheme, new OpenApiSecurityScheme
@@ -116,3 +117,10 @@ app.UseCors("cors");
 app.UseAuthorization();
 app.MapControllers();
 app.Run();
+
+
+string getSWDescription()
+{
+    var filePath = Path.Combine(AppContext.BaseDirectory, "SWDescription.txt");
+    return File.ReadAllText(filePath, Encoding.UTF8);
+}

QYMessageCenter/QYMessageCenter.csproj

@@ -7,6 +7,16 @@
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Remove="SWDescription.txt" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Content Include="SWDescription.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="FreeSql" Version="3.2.812" />
     <PackageReference Include="FreeSql.Provider.MySql" Version="3.2.812" />

QYMessageCenter/SWDescription.txt

@@ -0,0 +1,19 @@
+注意事项
+1.返回参数名称采用大驼峰命名
+2.ApiResponse为基础返回对象(Code,Data,Message),接口中所有的返回值均属于Data属性
+3.正常返回Code=200
+
+AppCode规范
+BBWYC 步步为盈C端
+BBWYB 步步为盈B端
+PJZS 评价助手
+QK 齐库
+LK 良库
+SBF 三板斧
+SN 司南
+
+Channel规范
+
+
+CustomTypeCode说明
+评价助手：