在后臺接口開發(fā)中,接口文檔是必不可少的。在復(fù)雜的業(yè)務(wù)當(dāng)中和多人對接的情況下,簡單的接口文檔又不能滿足需求,試想你的單應(yīng)用后臺有幾十個模塊,幾百甚至更多的接口,又有上百個ViewModel。怎么能讓人用起來更順手更明了?本篇介紹第一步的中度優(yōu)化,下一篇將分享下一階段的深度優(yōu)化。
第一篇:ASP.NET WebApi 文檔Swagger中度優(yōu)化
1.上手使用
2.Controller注釋讀取和漢化
3.Actionf group by 分組
4.通過exe整合xxxModel.xml和xxxAPI.XML
5.通過批處理命令在生成后調(diào)用exe
第二篇:ASP.NET WebApi 文檔Swashbuckle.Core與SwaggerUI深度定制
Swagger是一款完全開源的文檔工具,其優(yōu)點(diǎn)在于前后端的完整分離,他們之間的契約就是Json的數(shù)據(jù)格式。其后臺項目就是github中的Swashbuckle。其前臺項目就是github中的SwaggerUI。有一點(diǎn)需要注意的是,如果你直接從nuget安裝Swashbuckle的話,你也并不想做更多的定制化,那么UI界面你完全不需要處理,因為所有的資源Resources都是嵌入到Swashbuckle.dll當(dāng)中的,你可以在vs對象管理器中查看到Resources,如下圖,是不是又復(fù)習(xí)了dll的作用了呢?其中還可以包含css,js,image等資源:
看下本次分享的效果圖吧,只選了四個Controller做展示,個人覺得還是比較明