当使用WebAPI提供REST服务的时候,一个经常进行的操作是对接口进行测试。Asp.net WebAPI框架本身并没有提供这一接口,不过由于提供的是标准的REST服务,是可以非常方便的使用一些第三方的工具的。
我之前经常用的Chrome的Postman插件来进行测试,它可以用来模拟各种Http请求操作。虽然这个工具也算好用,不过由于它只是一个通用的工具,使用它的时候要构建Http报文头,并根据具体API组装消息体,这也是一件比较麻烦的事情。
今天网上闲逛的时候发现了一个更加好用的测试工具Swagger-UI,它专门针对REST接口提供了非常友好的测试界面:
不仅能提供接口列表,还能读取接口的参数列表,提供友好的配置接口:
接口说明,参数说明,参数类型都能都都出来,非常友好,甚至连参数的各个字段的注释都能标记出来,基本上都是一个非常友好的帮助文档了。
更多的示例可以参考它官方Demo:http://petstore.swagger.io/。 用它来进行测试非常简单,直接输入参数就行了,不用费力的构造各种URL和报文,比Postman方便多了。
由于篇幅所限,本文这里就只对Swagger-UI进行了一些简单的介绍,下篇文章中再详细介绍如何将Swagger-UI集成到WebAPI中。
时间: 2024-10-06 01:49:19