.Net Core WebApi

雪剑青春

目录

• MiniMalAPi
  
  
  
  • Demo
    
    
    
    • Program.cs
      
    
    
  
  
• Swagger
  
  
  
  • 文档+信息
    
    
    
    • Program.cs
      
    
    
  • API版本控制
    
    
    
    • ApiVersion.cs
      
    • Version1Controller.cs
      
    • Program.cs
      
    
    
  • 生成注释
    
  
  
• 解决跨域
  
• .Net 后台请求封装
  
• 返回数据压缩
  
  
  
  • 默认压缩
    
  • Gzip压缩
    
  
  
• 缓存
  
  
  
  • 接口缓存
    
  • 静态文件缓存
    
  
  

MiniMalAPi

• 最小的api, 请求都写在Program.cs中, 可以做微服务
  

Demo

Program.cs

1. //基本请求
2. app.MapGet("/GetTest", () => new { result = "123", code = 200 }).WithTags("General Request");
3. app.MapPost("/PostTest", () => new { result = "123", code = 200 }).WithTags("General Request");
4. app.MapPut("/PutTest", () => new { result = "123", code = 200 }).WithTags("General Request");
5. app.MapDelete("DeletePut", () => new { result = "123", code = 200 }).WithTags("General Request");
7. //注入
8. app.MapGet("/GetTestIoc", (IStudent student,IWrite pen) => student.Calligraphy(pen)).WithTags("Ioc");
9. app.MapGet("/GetTestIocById", (IStudent student,IWrite pen,int? id) => student.Calligraphy(pen)).WithTags("Ioc");
10. app.MapPost("/GetTestIocByObject", (IStudent student,IWrite pen,Result result) => student.Calligraphy(pen)).WithTags("Ioc");

复制代码

Swagger

文档+信息

Program.cs

1. builder.Services.AddSwaggerGen(setup =>
2. {
3.     setup.SwaggerDoc("V1", new()
4.     {
5.         Title = "qfccc",
6.         Version = "V1",
7.         Description = "qfccc description",
8.     });
9. });
11. app.UseSwaggerUI(setup =>
12. {
13.     setup.SwaggerEndpoint("/swagger/V1/swagger.json", "V1");
14. });

复制代码

API版本控制

• 该例子仅供参考
  

ApiVersion.cs

1. namespace WebApiDemo.VersionControl
2. {
3.     public class ApiVersion
4.     {
5.         public static string? Version1;
6.         public static string? Version2;
7.         public static string? Version3;
8.         public static string? Version4;
9.         public static string? Version5;
10.     }
11. }

复制代码

Version1Controller.cs

• 这里其他版本api 修改ApiVersion.Version1即可
  

1. using Microsoft.AspNetCore.Http;
2. using Microsoft.AspNetCore.Mvc;
3. using WebApiDemo.VersionControl;
5. namespace WebApiDemo.Controllers
6. {
7.     [ApiExplorerSettings(GroupName = nameof(ApiVersion.Version1))]
8.     [Route($"api/[controller]/[action]/api.{nameof(ApiVersion.Version1)}")]
9.     [ApiController]
10.     public class Version1Controller : ControllerBase
11.     {
13.         [HttpGet]
14.         public IActionResult GetString() => new JsonResult(new { result = "Success" });
16.         [HttpPost]
17.         public IActionResult PostString() => new JsonResult(new { result = "Success" });
19.         [HttpPut]
20.         public IActionResult PutString() => new JsonResult(new { result = "Success" });
22.         [HttpDelete]
23.         public IActionResult DeleteString() => new JsonResult(new { result = "Success" });
24.     }
25. }

复制代码

Program.cs

1. builder.Services.AddSwaggerGen(setup =>
2. {
3.     foreach (var field in typeof(ApiVersion).GetFields())
4.     {
5.         setup.SwaggerDoc(field.Name, new()
6.         {
7.             Title = "qfccc",
8.             Version = field.Name,
9.             Description = $"qfccc api {field.Name}",
10.         });
11.     }
12. });
14. app.UseSwaggerUI(setup =>
15. {
16.     foreach (var field in typeof(ApiVersion).GetFields())
17.     {
18.         setup.SwaggerEndpoint($"/swagger/{field.Name}/swagger.json", field.Name);
19.     }
20. });

复制代码

生成注释

• 项目点击右键 -> 属性 -> 输出 -> 勾选(文档文件)
  
• 在AddSwaggerGen中间件添加下方代码
  

1. string? basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);
2. if(basePath is not null)
3. {
4.     string apiPath = Path.Combine(basePath, "项目名称.xml");
5.     setup.IncludeXmlComments(apiPath);
6. }

复制代码

解决跨域

• 调用方调用自己后台,然后用后台请求目标接口解决跨域
  
• 服务器支持跨域请求
  
  
  
  • 在Action中添加这行代码:
    
  • HttpContext.Response.Headers.Add("Access-Control-Allow-Origin", "*");
    
  
  
• 使用ActionFilter 实现过滤器,代码与上方一致, 然后在Program.cs 文件中全局注册一下该过滤器,但是不支持Post,Put,Delete这种请求
  
• 所有请求都支持跨域可以在Program.cs中增加下方代码:
  

1. builder.Services.AddCors( setup =>
2. {
3.     setup.AddPolicy("SolveCrossOrigin", policy =>
4.     {
5.         policy.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin();
6.     });
7. });
10. app.UseCors("SolveCrossOrigin");

复制代码

.Net 后台请求封装

1. using Newtonsoft.Json;
2. using System;
3. using System.Collections.Generic;
4. using System.Net.Http;
5. using System.Text;
6. using System.Threading.Tasks;
8. namespace NET5WebApplication.Utility
9. {
10.     public static class HttpClientHelper
11.     {
12.         /// <summary>
13.         /// 发起POST同步请求
14.         /// </summary>
15.         /// <param name="url"></param>
16.         /// <param name="postData"></param>
17.         /// <param name="contentType">application/xml、application/json、application/text、application/x-www-form-urlencoded</param>
18.         /// <param name="headers">填充消息头</param>
19.         /// <returns></returns>
20.         public static string HttpPost(string url, string postData = null, string contentType = "application/json", int timeOut = 30, Dictionary<string, string> headers = null)
21.         {
22.             postData = postData ?? "";
23.             using (HttpClient client = new System.Net.Http.HttpClient())
24.             {
25.                 if (headers != null)
26.                 {
27.                     foreach (var header in headers)
28.                         client.DefaultRequestHeaders.Add(header.Key, header.Value);
29.                 }
30.                 using (HttpContent httpContent = new StringContent(postData, Encoding.UTF8))
31.                 {
32.                     if (contentType != null)
33.                         httpContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue(contentType);
34.                     HttpResponseMessage response = client.PostAsync(url, httpContent).Result;
35.                     return response.Content.ReadAsStringAsync().Result;
36.                 }
37.             }
38.         }
40.         /// <summary>
41.         /// 发起POST异步请求
42.         /// </summary>
43.         /// <param name="url"></param>
44.         /// <param name="postData"></param>
45.         /// <param name="contentType">application/xml、application/json、application/text、application/x-www-form-urlencoded</param>
46.         /// <param name="headers">填充消息头</param>
47.         /// <returns></returns>
48.         public static async Task<string> HttpPostAsync(string url, string postData = null, string contentType = "application/json", int timeOut = 30, Dictionary<string, string> headers = null)
49.         {
50.             postData = postData ?? "";
51.             using (System.Net.Http.HttpClient client = new System.Net.Http.HttpClient())
52.             {
53.                 client.Timeout = new TimeSpan(0, 0, timeOut);
54.                 if (headers != null)
55.                 {
56.                     foreach (var header in headers)
57.                         client.DefaultRequestHeaders.Add(header.Key, header.Value);
58.                 }
59.                 using (HttpContent httpContent = new StringContent(postData, Encoding.UTF8))
60.                 {
61.                     if (contentType != null)
62.                         httpContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue(contentType);
64.                     HttpResponseMessage response = await client.PostAsync(url, httpContent);
65.                     return await response.Content.ReadAsStringAsync();
66.                 }
67.             }
68.         }
70.         /// <summary>
71.         /// 发起GET同步请求
72.         /// </summary>
73.         /// <param name="url"></param>
74.         /// <param name="headers"></param>
75.         /// <param name="contentType"></param>
76.         /// <returns></returns>
77.         public static string HttpGet(string url, string contentType = "application/json", Dictionary<string, string> headers = null)
78.         {
79.             using (HttpClient client = new HttpClient())
80.             {
81.                 if (contentType != null)
82.                     client.DefaultRequestHeaders.Add("ContentType", contentType);
83.                 if (headers != null)
84.                 {
85.                     foreach (var header in headers)
86.                         client.DefaultRequestHeaders.Add(header.Key, header.Value);
87.                 }
88.                 HttpResponseMessage response = client.GetAsync(url).Result;
89.                 return response.Content.ReadAsStringAsync().Result;
90.             }
91.         }
93.         /// <summary>
94.         /// 发起GET异步请求
95.         /// </summary>
96.         /// <param name="url"></param>
97.         /// <param name="headers"></param>
98.         /// <param name="contentType"></param>
99.         /// <returns></returns>
100.         public static async Task<string> HttpGetAsync(string url, string contentType = "application/json", Dictionary<string, string> headers = null)
101.         {
102.             using (System.Net.Http.HttpClient client = new System.Net.Http.HttpClient())
103.             {
104.                 if (contentType != null)
105.                     client.DefaultRequestHeaders.Add("ContentType", contentType);
106.                 if (headers != null)
107.                 {
108.                     foreach (var header in headers)
109.                         client.DefaultRequestHeaders.Add(header.Key, header.Value);
110.                 }
111.                 HttpResponseMessage response = await client.GetAsync(url);
112.                 return await response.Content.ReadAsStringAsync();
113.             }
114.         }
116.         /// <summary>
117.         /// 发起POST同步请求
118.         /// </summary>
119.         /// <param name="url"></param>
120.         /// <param name="postData"></param>
121.         /// <param name="contentType">application/xml、application/json、application/text、application/x-www-form-urlencoded</param>
122.         /// <param name="headers">填充消息头</param>
123.         /// <returns></returns>
124.         public static T HttpPost<T>(string url, string postData = null, string contentType = "application/json", int timeOut = 30, Dictionary<string, string> headers = null)
125.         {
126.             return HttpPost(url, postData, contentType, timeOut, headers).ToEntity<T>();
127.         }
129.         /// <summary>
130.         /// 发起POST异步请求
131.         /// </summary>
132.         /// <param name="url"></param>
133.         /// <param name="postData"></param>
134.         /// <param name="contentType">application/xml、application/json、application/text、application/x-www-form-urlencoded</param>
135.         /// <param name="headers">填充消息头</param>
136.         /// <returns></returns>
137.         public static async Task<T> HttpPostAsync<T>(string url, string postData = null, string contentType = "application/json", int timeOut = 30, Dictionary<string, string> headers = null)
138.         {
139.             var res = await HttpPostAsync(url, postData, contentType, timeOut, headers);
140.             return res.ToEntity<T>();
141.         }
143.         /// <summary>
144.         /// 发起GET同步请求
145.         /// </summary>
146.         /// <param name="url"></param>
147.         /// <param name="headers"></param>
148.         /// <param name="contentType"></param>
149.         /// <returns></returns>
150.         public static T HttpGet<T>(string url, string contentType = "application/json", Dictionary<string, string> headers = null)
151.         {
152.             return HttpGet(url, contentType, headers).ToEntity<T>();
153.         }
155.         /// <summary>
156.         /// 发起GET异步请求
157.         /// </summary>
158.         /// <param name="url"></param>
159.         /// <param name="headers"></param>
160.         /// <param name="contentType"></param>
161.         /// <returns></returns>
162.         public static async Task<T> HttpGetAsync<T>(string url, string contentType = "application/json", Dictionary<string, string> headers = null)
163.         {
164.             var res = await HttpGetAsync(url, contentType, headers);
165.             return res.ToEntity<T>();
166.         }
167.     }
169.     public static class HttpExtension
170.     {
171.         /// <summary>
172.         /// 发起GET同步请求
173.         /// </summary>
174.         /// <param name="client"></param>
175.         /// <param name="url"></param>
176.         /// <param name="headers"></param>
177.         /// <param name="contentType"></param>
178.         /// <returns></returns>
179.         public static string HttpGet(this System.Net.Http.HttpClient client, string url, string contentType = "application/json",
180.                                      Dictionary<string, string> headers = null)
181.         {
182.             if (contentType != null)
183.                 client.DefaultRequestHeaders.Add("ContentType", contentType);
184.             if (headers != null)
185.             {
186.                 foreach (var header in headers)
187.                     client.DefaultRequestHeaders.Add(header.Key, header.Value);
188.             }
189.             HttpResponseMessage response = client.GetAsync(url).Result;
190.             return response.Content.ReadAsStringAsync().Result;
191.         }
193.         /// <summary>
194.         /// 发起GET异步请求
195.         /// </summary>
196.         /// <param name="client"></param>
197.         /// <param name="url"></param>
198.         /// <param name="headers"></param>
199.         /// <param name="contentType"></param>
200.         /// <returns></returns>
201.         public static async Task<string> HttpGetAsync(this System.Net.Http.HttpClient client, string url, string contentType = "application/json", Dictionary<string, string> headers = null)
202.         {
203.             if (contentType != null)
204.                 client.DefaultRequestHeaders.Add("ContentType", contentType);
205.             if (headers != null)
206.             {
207.                 foreach (var header in headers)
208.                     client.DefaultRequestHeaders.Add(header.Key, header.Value);
209.             }
210.             HttpResponseMessage response = await client.GetAsync(url);
211.             return await response.Content.ReadAsStringAsync();
212.         }
214.         /// <summary>
215.         /// 发起POST同步请求
216.         /// </summary>
217.         /// <param name="client"></param>
218.         /// <param name="url"></param>
219.         /// <param name="postData"></param>
220.         /// <param name="contentType">application/xml、application/json、application/text、application/x-www-form-urlencoded</param>
221.         /// <param name="timeOut"></param>
222.         /// <param name="headers">填充消息头</param>
223.         /// <returns></returns>
224.         public static string HttpPost(this System.Net.Http.HttpClient client, string url, string postData = null,
225.                                       string contentType = "application/json", int timeOut = 30, Dictionary<string, string> headers = null)
226.         {
227.             postData = postData ?? "";
228.             if (headers != null)
229.             {
230.                 foreach (var header in headers)
231.                     client.DefaultRequestHeaders.Add(header.Key, header.Value);
232.             }
233.             using (HttpContent httpContent = new StringContent(postData, Encoding.UTF8))
234.             {
235.                 if (contentType != null)
236.                     httpContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue(contentType);
238.                 HttpResponseMessage response = client.PostAsync(url, httpContent).Result;
239.                 return response.Content.ReadAsStringAsync().Result;
240.             }
241.         }
243.         /// <summary>
244.         /// 发起POST异步请求
245.         /// </summary>
246.         /// <param name="client"></param>
247.         /// <param name="url"></param>
248.         /// <param name="postData"></param>
249.         /// <param name="contentType">application/xml、application/json、application/text、application/x-www-form-urlencoded</param>
250.         /// <param name="headers">填充消息头</param>
251.         /// <returns></returns>
252.         public static async Task<string> HttpPostAsync(this System.Net.Http.HttpClient client, string url, string postData = null, string contentType = "application/json", int timeOut = 30, Dictionary<string, string> headers = null)
253.         {
254.             postData = postData ?? "";
255.             client.Timeout = new TimeSpan(0, 0, timeOut);
256.             if (headers != null)
257.             {
258.                 foreach (var header in headers)
259.                     client.DefaultRequestHeaders.Add(header.Key, header.Value);
260.             }
261.             using (HttpContent httpContent = new StringContent(postData, Encoding.UTF8))
262.             {
263.                 if (contentType != null)
264.                     httpContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue(contentType);
266.                 HttpResponseMessage response = await client.PostAsync(url, httpContent);
267.                 return await response.Content.ReadAsStringAsync();
268.             }
269.         }
271.         /// <summary>
272.         /// 发起POST同步请求
273.         /// </summary>
274.         /// <param name="url"></param>
275.         /// <param name="postData"></param>
276.         /// <param name="contentType">application/xml、application/json、application/text、application/x-www-form-urlencoded</param>
277.         /// <param name="headers">填充消息头</param>
278.         /// <returns></returns>
279.         public static T HttpPost<T>(this System.Net.Http.HttpClient client, string url, string postData = null, string contentType = "application/json", int timeOut = 30, Dictionary<string, string> headers = null)
280.         {
281.             return client.HttpPost(url, postData, contentType, timeOut, headers).ToEntity<T>();
282.         }
284.         /// <summary>
285.         /// 发起POST异步请求
286.         /// </summary>
287.         /// <param name="url"></param>
288.         /// <param name="postData"></param>
289.         /// <param name="contentType">application/xml、application/json、application/text、application/x-www-form-urlencoded</param>
290.         /// <param name="headers">填充消息头</param>
291.         /// <returns></returns>
292.         public static async Task<T> HttpPostAsync<T>(this System.Net.Http.HttpClient client, string url, string postData = null, string contentType = "application/json", int timeOut = 30, Dictionary<string, string> headers = null)
293.         {
294.             var res = await client.HttpPostAsync(url, postData, contentType, timeOut, headers);
295.             return res.ToEntity<T>();
296.         }
298.         /// <summary>
299.         /// 发起GET同步请求
300.         /// </summary>
301.         /// <param name="url"></param>
302.         /// <param name="headers"></param>
303.         /// <param name="contentType"></param>
304.         /// <returns></returns>
305.         public static T HttpGet<T>(this System.Net.Http.HttpClient client, string url, string contentType = "application/json", Dictionary<string, string> headers = null)
306.         {
307.             return client.HttpGet(url, contentType, headers).ToEntity<T>();
308.         }
310.         /// <summary>
311.         /// 发起GET异步请求
312.         /// </summary>
313.         /// <param name="url"></param>
314.         /// <param name="headers"></param>
315.         /// <param name="contentType"></param>
316.         /// <returns></returns>
317.         public static async Task<T> HttpGetAsync<T>(this System.Net.Http.HttpClient client, string url, string contentType = "application/json", Dictionary<string, string> headers = null)
318.         {
319.             var res = await client.HttpGetAsync(url, contentType, headers);
320.             return res.ToEntity<T>();
321.         }
322.     }
324.     public static class JsonExtends
325.     {
326.         public static T ToEntity<T>(this string val)
327.         {
328.             return JsonConvert.DeserializeObject<T>(val);
329.         }
330.         public static string ToJson<T>(this T entity, Formatting formatting = Formatting.None)
331.         {
332.             return JsonConvert.SerializeObject(entity, formatting);
333.         }
334.     }
335. }

复制代码

返回数据压缩

• 在Program.cs中添加下面代码
  

默认压缩

1. builder.Services.AddResponseCompression();
2. app.UseResponseCompression();

复制代码

Gzip压缩

1. builder.Services.AddResponseCompression(config =>
2. {
3.     config.Providers.Add<GzipCompressionProvider>();
4. });
6. builder.Services.Configure<GzipCompressionProviderOptions>(config =>
7. {
8.     config.Level = CompressionLevel.SmallestSize;
9. });

复制代码

缓存

接口缓存

• 使用特性或者直接在返回头中添加Cache-Control效果一样
  

1. [HttpGet]
2. [ResponseCache(Duration = 600)]
3. public IActionResult GetString() => new JsonResult(new { result = "Success" });
5. [HttpGet]
6. public IActionResult GetStringEx()
7. {
8.     HttpContext.Response.Headers.Add("Cache-Control", "public,max-age=600");
9.     return new JsonResult(new { result = "Success" });
10. }

复制代码

静态文件缓存

1. app.UseStaticFiles(new StaticFileOptions()
2. {
3.     OnPrepareResponse = Prepare =>
4.     {
5.         Prepare.Context.Response.Headers.Add(HeaderNames.CacheControl, "public,max-age=600");
6.     }
7. });

复制代码

来源:https://www.cnblogs.com/qfccc/archive/2023/08/08/17615157.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！