您好,登錄后才能下訂單哦!
這篇文章將為大家詳細(xì)講解有關(guān)如何使用swagger上傳文件,文章內(nèi)容質(zhì)量較高,因此小編分享給大家做個(gè)參考,希望大家閱讀完這篇文章后對相關(guān)知識有一定的了解。
1安裝swagger
nuget安裝Swashbuckle.AspNetCore.Swagger組件
2設(shè)置生成xml
右鍵項(xiàng)目>屬性>生成
相應(yīng)的把其他需要生成文檔說明的項(xiàng)目也按上步驟進(jìn)行設(shè)置xml
關(guān)鍵swagger代碼
using Microsoft.AspNetCore.Builder; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.PlatformAbstractions; using Swashbuckle.AspNetCore.Swagger; using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Threading.Tasks; namespace Chaunce.Api.App_Start { /// <summary> /// SwaggerConfig /// </summary> public class SwaggerConfig { /// <summary> /// InitSwagger /// </summary> /// <param name="services"></param> public static void InitSwagger(IServiceCollection services) { services.AddSwaggerGen(c => { c.OperationFilter<SwaggerFileUploadFilter>();//增加文件過濾處理 var security = new Dictionary<string, IEnumerable<string>> { { "Bearer", new string[] { } }, }; c.AddSecurityRequirement(security);//添加一個(gè)必須的全局安全信息,和AddSecurityDefinition方法指定的方案名稱要一致,這里是Bearer。 var basePath = PlatformServices.Default.Application.ApplicationBasePath;// 獲取到應(yīng)用程序的根路徑 var xmlApiPath = Path.Combine(basePath, "Chaunce.Api.xml");//api文件xml(在以上步驟2設(shè)置生成xml的路徑) var xmlModelPath = Path.Combine(basePath, "Chaunce.ViewModels.xml");//請求modelxml c.IncludeXmlComments(xmlApiPath); c.IncludeXmlComments(xmlModelPath); c.SwaggerDoc("v1", new Info { Title = "Chaunce數(shù)據(jù)接口", Version = "v1", Description = "這是一個(gè)webapi接口文檔說明", TermsOfService = "None", Contact = new Contact { Name = "Chaunce官網(wǎng)", Email = "info@Chaunce.com", Url = "http://blog.Chaunce.top/" }, License = new License { Name = "Swagger官網(wǎng)", Url = "http://swagger.io/", } }); c.IgnoreObsoleteActions(); c.AddSecurityDefinition("Bearer", new ApiKeyScheme { Description = "權(quán)限認(rèn)證(數(shù)據(jù)將在請求頭中進(jìn)行傳輸) 參數(shù)結(jié)構(gòu): \"Authorization: Bearer {token}\"", Name = "Authorization",//jwt默認(rèn)的參數(shù)名稱 In = "header",//jwt默認(rèn)存放Authorization信息的位置(請求頭中) Type = "apiKey" });//Authorization的設(shè)置 }); } /// <summary> /// ConfigureSwagger /// </summary> /// <param name="app"></param> public static void ConfigureSwagger(IApplicationBuilder app) { app.UseSwagger(); // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), specifying the Swagger JSON endpoint. app.UseSwagger(c => { c.RouteTemplate = "docs/{documentName}/docs.json";//使中間件服務(wù)生成Swagger作為JSON端點(diǎn)(此處設(shè)置是生成接口文檔信息,可以理解為老技術(shù)中的webservice的soap協(xié)議的信息,暴露出接口信息的地方) c.PreSerializeFilters.Add((swaggerDoc, httpReq) => swaggerDoc.Info.Description = httpReq.Path);//請求過濾處理 }); app.UseSwaggerUI(c => { c.RoutePrefix = "docs";//設(shè)置文檔首頁根路徑 c.SwaggerEndpoint("/docs/v1/docs.json", "V1");//此處配置要和UseSwagger的RouteTemplate匹配 //c.SwaggerEndpoint("/swagger/v1/swagger.json", "V1");//默認(rèn)終結(jié)點(diǎn) c.InjectStylesheet("/swagger-ui/custom.css");//注入style文件 }); } } }
swagger過濾器
using Microsoft.AspNetCore.Http; using Swashbuckle.AspNetCore.Swagger; using Swashbuckle.AspNetCore.SwaggerGen; using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; namespace Chaunce.Api.Help { /// <summary> /// swagger文件過濾器 /// </summary> public class SwaggerFileUploadFilter : IOperationFilter { /// <summary> /// swagger過濾器(此處的Apply會被swagger的每個(gè)接口都調(diào)用生成文檔說明,所以在此處可以對每一個(gè)接口進(jìn)行過濾操作) /// </summary> /// <param name="operation"></param> /// <param name="context"></param> public void Apply(Operation operation, OperationFilterContext context) { if (!context.ApiDescription.HttpMethod.Equals("POST", StringComparison.OrdinalIgnoreCase) && !context.ApiDescription.HttpMethod.Equals("PUT", StringComparison.OrdinalIgnoreCase)) { return; } var apiDescription = context.ApiDescription; var parameters = context.ApiDescription.ParameterDescriptions.Where(n => n.Type == typeof(IFormFileCollection) || n.Type == typeof(IFormFile)).ToList();//parameterDescriptions包含了每個(gè)接口所帶所有參數(shù)信息 if (parameters.Count() <= 0) { return; } operation.Consumes.Add("multipart/form-data"); foreach (var fileParameter in parameters) { var parameter = operation.Parameters.Single(n => n.Name == fileParameter.Name); operation.Parameters.Remove(parameter); operation.Parameters.Add(new NonBodyParameter { Name = parameter.Name, In = "formData", Description = parameter.Description, Required = parameter.Required, Type = "file", //CollectionFormat = "multi" }); } } } }
打開瀏覽器http://localhost:8532/docs/
還沒有結(jié)束,我們看看如何讓Jwt的認(rèn)證信息自動存在請求頭免去每次手動塞
點(diǎn)擊
(實(shí)際情況是填寫的信息格式是:Bearer *************(Bearer與后面信息有一個(gè)空格))
此時(shí)隨意訪問任何api,都會將以上信息自動塞入header中進(jìn)行請求,如下驗(yàn)證
關(guān)于如何使用swagger上傳文件就分享到這里了,希望以上內(nèi)容可以對大家有一定的幫助,可以學(xué)到更多知識。如果覺得文章不錯(cuò),可以把它分享出去讓更多的人看到。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。