ServiceStack如何集成Swagger
这篇文章主要为大家展示了“ServiceStack如何集成Swagger”,内容简而易懂,条理清晰,希望能够帮助大家解决疑惑,下面让小编带领大家一起研究并学习一下“ServiceStack如何集成Swagger”这篇文章吧。
Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。
ServiceStack集成了此软件,通过一系列的配置,实现通过网页打开Swagger的界面,查看服务接口的详细说明,根据参数调用服务,返回数据的结果。
ServiceStack服务简单搭建:参见ServiceStack简单服务发布。
Swagger简单配置过程:
添加Swagger的dll引用,查找和自己使用的ServiceStack对应版本的即可。
在apphost中,添加插件的配置的代码;
Plugins.Add(new SwaggerFeature());
在Service中服务对应类定义上,添加对应的属性,使用Api属性和ApiMember属性:
[Api("获得指定日期当个污染源的详细信息")]
[Route("/serviceroute")]
public class servicedefine: IReturn<model>
{
[ApiMember(Name = "DateStr", Description = "统计日期,格式为yyyyMMdd", DataType = "string", IsRequired = true)]
public string DateStr { get; set; }
}
通过输入网址,打开Swagger的网页,根据ServiceStack的服务网址和端口号,中间加上swagger-ui的路由即可。
http://IP地址:端口号/swagger-ui/
网页列表会显示所有的服务,以及服务的说明,输入对应的参数,即可调用服务,查看返回参数。
ServiceStack本身自带了服务说明,没有Swagger这样功能全面,直接输入http://IP地址:端口号就能显示默认的说明页,其中里边能够查看相应的参数,但是没有提供服务直接调用的方式。
以上是“ServiceStack如何集成Swagger”这篇文章的所有内容,感谢各位的阅读!相信大家都有了一定的了解,希望分享的内容对大家有所帮助,如果还想学习更多知识,欢迎关注行业资讯频道!