這篇文章主要為大家展示了“ServiceStack如何集成Swagger”,內(nèi)容簡(jiǎn)而易懂,條理清晰,希望能夠幫助大家解決疑惑,下面讓小編帶領(lǐng)大家一起研究并學(xué)習(xí)一下“ServiceStack如何集成Swagger”這篇文章吧。
10年積累的成都做網(wǎng)站、網(wǎng)站制作經(jīng)驗(yàn),可以快速應(yīng)對(duì)客戶(hù)對(duì)網(wǎng)站的新想法和需求。提供各種問(wèn)題對(duì)應(yīng)的解決方案。讓選擇我們的客戶(hù)得到更好、更有力的網(wǎng)絡(luò)服務(wù)。我雖然不認(rèn)識(shí)你,你也不認(rèn)識(shí)我。但先網(wǎng)站策劃后付款的網(wǎng)站建設(shè)流程,更有江漢免費(fèi)網(wǎng)站建設(shè)讓你可以放心的選擇與我們合作。
Swagger 是一款RESTFUL接口的文檔在線自動(dòng)生成+功能測(cè)試功能軟件。
ServiceStack集成了此軟件,通過(guò)一系列的配置,實(shí)現(xiàn)通過(guò)網(wǎng)頁(yè)打開(kāi)Swagger的界面,查看服務(wù)接口的詳細(xì)說(shuō)明,根據(jù)參數(shù)調(diào)用服務(wù),返回?cái)?shù)據(jù)的結(jié)果。
ServiceStack服務(wù)簡(jiǎn)單搭建:參見(jiàn)ServiceStack簡(jiǎn)單服務(wù)發(fā)布。
Swagger簡(jiǎn)單配置過(guò)程:
添加Swagger的dll引用,查找和自己使用的ServiceStack對(duì)應(yīng)版本的即可。
在apphost中,添加插件的配置的代碼;
Plugins.Add(new SwaggerFeature());
在Service中服務(wù)對(duì)應(yīng)類(lèi)定義上,添加對(duì)應(yīng)的屬性,使用Api屬性和ApiMember屬性:
[Api("獲得指定日期當(dāng)個(gè)污染源的詳細(xì)信息")]
[Route("/serviceroute")]
public class servicedefine: IReturn
{
[ApiMember(Name = "DateStr", Description = "統(tǒng)計(jì)日期,格式為yyyyMMdd", DataType = "string", IsRequired = true)]
public string DateStr { get; set; }
}
通過(guò)輸入網(wǎng)址,打開(kāi)Swagger的網(wǎng)頁(yè),根據(jù)ServiceStack的服務(wù)網(wǎng)址和端口號(hào),中間加上swagger-ui的路由即可。
http://IP地址:端口號(hào)/swagger-ui/
網(wǎng)頁(yè)列表會(huì)顯示所有的服務(wù),以及服務(wù)的說(shuō)明,輸入對(duì)應(yīng)的參數(shù),即可調(diào)用服務(wù),查看返回參數(shù)。
ServiceStack本身自帶了服務(wù)說(shuō)明,沒(méi)有Swagger這樣功能全面,直接輸入http://IP地址:端口號(hào)就能顯示默認(rèn)的說(shuō)明頁(yè),其中里邊能夠查看相應(yīng)的參數(shù),但是沒(méi)有提供服務(wù)直接調(diào)用的方式。
以上是“ServiceStack如何集成Swagger”這篇文章的所有內(nèi)容,感謝各位的閱讀!相信大家都有了一定的了解,希望分享的內(nèi)容對(duì)大家有所幫助,如果還想學(xué)習(xí)更多知識(shí),歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道!