Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。

ServiceStack集成了此软件,通过一系列的配置,实现通过网页打开Swagger的界面,查看服务接口的详细说明,根据参数调用服务,返回数据的结果。

ServiceStack服务简单搭建:参见​​ServiceStack简单服务发布​​。

Swagger简单配置过程:

添加Swagger的dll引用,查找和自己使用的ServiceStack对应版本的即可。

ServiceStack:集成Swagger_自动生成

在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_ip地址_02

ServiceStack本身自带了服务说明,没有Swagger这样功能全面,直接输入http://IP地址:端口号就能显示默认的说明页,其中里边能够查看相应的参数,但是没有提供服务直接调用的方式。