WebApi中Swagger的使用(超級簡單)


Swagger解釋

Swagger是一種Rest API的簡單但強大的表示方式,她是標准的與語言無關,這種表示方式不但人可讀,而且機器可讀。 可以作為Rest API的交互式文檔,也可以作為Rest API的形式化的接口描述,生成客戶端和服務端的代碼。

Swagger能成為最受歡迎的REST APIs文檔生成工具的原因

Swagger 可以生成一個具有互動性的API控制台,開發者可以用來快速學習和嘗試API。
Swagger 可以生成客戶端SDK代碼用於各種不同的平台上的實現。
Swagger 文件可以在許多不同的平台上從代碼注釋中自動生成。
Swagger 有一個強大的社區,里面有許多強悍的貢獻者。

在.NET中Web Api中的使用

1. NuGet上引用Swashbuckle(5.6.0)
2. 項目右鍵項目屬性 》 生成 》 XML文檔文件(建議直接項目名.xml,方便下一步的xml的獲取)
3. SwaggerConfig中修改c.IncludeXmlComments(commentsFile),以便於action上注釋的顯示

var baseDirectory = AppDomain.CurrentDomain.BaseDirectory;
var commentsFileName = Assembly.GetExecutingAssembly().GetName().Name + ".XML";
var commentsFile = Path.Combine(baseDirectory, commentsFileName);
c.IncludeXmlComments(commentsFile);

4. 運行,http://localhost:端口/swagger/ui/index

5.效果如圖


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM