本篇文章為大家展示了怎么在Asp.Net Core中使用swagger生成一個(gè)api文檔,內(nèi)容簡明扼要并且容易理解,絕對能使你眼前一亮,通過這篇文章的詳細(xì)介紹希望你能有所收獲。
創(chuàng)新互聯(lián)-專業(yè)網(wǎng)站定制、快速模板網(wǎng)站建設(shè)、高性價(jià)比華安網(wǎng)站開發(fā)、企業(yè)建站全套包干低至880元,成熟完善的模板庫,直接使用。一站式華安網(wǎng)站制作公司更省心,省錢,快速模板網(wǎng)站建設(shè)找我們,業(yè)務(wù)覆蓋華安地區(qū)。費(fèi)用合理售后完善,十余年實(shí)體公司更值得信賴。一、前期準(zhǔn)備
1、初始化asp.net core 測試項(xiàng)目
新建asp.net core項(xiàng)目,此處略過;
新建apicontroller,并編寫測試代碼;
[Route("api/[controller]")] [ApiController] public class UserApiController : ControllerBase { /// <summary> /// 獲取用戶信息,根據(jù)用戶id /// </summary> /// <param name="id">用戶id</param> /// <returns></returns> [HttpGet("getuser/{id}")] public ActionResult GetUser(int id) { User u = new User { Id=1,Name="Jack"}; return Ok(new { ok = true, data = u }); } /// <summary> /// 添加用戶 /// </summary> /// <param name="user">用戶信息</param> /// <returns></returns> [HttpPost("postuser")] public ActionResult AddUser([FromBody]User user) { return Ok(new { ok = true, data = user }); } }
public class User { /// <summary> /// 用戶id /// </summary> public int Id { get; set; } /// <summary> /// 用戶姓名 /// </summary> public string Name { get; set; } }
2、使用nuget安裝 NSwag.AspNetCore
方式一:通過vs圖形界面安裝;
方式二:通過nuget 命令安裝:
Install-Package NSwag.AspNetCore
二、配置Swagger
1、添加并配置 Swagger 中間件
在應(yīng)用的Startup類中的ConfigureServices 方法中,注冊所需的 Swagger 服務(wù):
public void ConfigureServices(IServiceCollection services) { services.AddControllersWithViews(); // Register the Swagger services services.AddSwaggerDocument() }
在 Startup類中的Configure 方法中,啟用中間件為生成的 Swagger 規(guī)范和 Swagger UI 提供服務(wù):
public void Configure(IApplicationBuilder app) { app.UseStaticFiles(); // Register the Swagger generator and the Swagger UI middlewares app.UseOpenApi(); app.UseSwaggerUi3(); app.UseMvc(); }
啟動應(yīng)用。 轉(zhuǎn)到:
http://localhost:/swagger,以查看 Swagger UI。
http://localhost:/swagger/v1/swagger.json,以查看 Swagger 規(guī)范。
2、自定義 API 文檔
API 信息和說明
在 Startup.ConfigureServices 方法中,傳遞給 AddSwaggerDocument 方法的配置操作會添加諸如作者、許可證和說明的信息:
public void ConfigureServices(IServiceCollection services) { //services.AddControllers(); services.AddControllersWithViews(); services.AddSwaggerDocument(config => { config.PostProcess = document => { document.Info.Version = "v1"; document.Info.Title = "UserManageApp API"; document.Info.Description = "A simple ASP.NET Core web API"; document.Info.TermsOfService = "None"; document.Info.Contact = new NSwag.OpenApiContact { Name = "張三", Email = string.Empty, Url = "https://example.com" }; document.Info.License = new NSwag.OpenApiLicense { Name = "Use under LICX", Url = "https://example.com/license" }; }; }); }
Swagger UI 顯示版本的信息:
XML 注釋
若要啟用 XML 注釋,請執(zhí)行以下步驟:
以windows先使用vs為例:
在“解決方案資源管理器”中右鍵單擊該項(xiàng)目,然后選擇“編輯 .csproj” 。
手動將突出顯示的行添加到 .csproj 文件 :
上述內(nèi)容就是怎么在Asp.Net Core中使用swagger生成一個(gè)api文檔,你們學(xué)到知識或技能了嗎?如果還想學(xué)到更多技能或者豐富自己的知識儲備,歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。
當(dāng)前標(biāo)題:怎么在Asp.NetCore中使用swagger生成一個(gè)api文檔-創(chuàng)新互聯(lián)
鏈接分享:http://muchs.cn/article16/cosjdg.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供營銷型網(wǎng)站建設(shè)、響應(yīng)式網(wǎng)站、全網(wǎng)營銷推廣、品牌網(wǎng)站建設(shè)、品牌網(wǎng)站制作、用戶體驗(yàn)
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來源: 創(chuàng)新互聯(lián)
猜你還喜歡下面的內(nèi)容