在开发中我们经常会碰到这种情况：后台开发人员在开发完接口之后给前台人员调用，前台人员对接口的作用以及接口中的参数往往不懂，这样前台不得不多次跟后台人员沟通交流，很浪费时间。但使用swagger后，这种情况就几乎不存在了，因为后台开发人员在写接口的同时便把接口及参数的注释写好了，在swagger页面可以非常清楚明了的看到各个接口以及各个参数的意思。即便如此，软件测试也要坚守行业的品质，为公司打造独一无二的产品。
我们先看看效果图，下图中明确显示了当前访问的接口属于"order-controller"，显示了请求url路径为"ordernewgetorder"，显示了该接口的作用为"获取某条订单信息"，显示了这个接口所用到的三个参数以及三个参数的名称以及类型。我们还可以点击下面的"try it out!"按钮来进行测试。有了它，后台人员不用讲解，前端人员自然能明白。
下面就说下如何使用开发工具intellijidea来搭建swagger应用。
第一步： 首先新建一个空的maven工程
第二步：在pomxml文件中添加如下依赖<parent>
<groupid>orgspringframeworkboot<groupid>
<artifactid>spring-boot-starter-parent<artifactid>
<version>141release<version>
<relativepath >
<parent>
<dependencies>
<dependency>
<groupid>orgspringframeworkboot<groupid>
<artifactid>spring-boot-starter-web<artifactid>
<version>141release<version>
<dependency>
<dependency>
<groupid>orgspringframework<groupid>
<artifactid>spring-web<artifactid>
<version>436release<version>
<dependency>
<dependency>
<groupid>orgspringframework<groupid>
<artifactid>spring-test<artifactid>
<version>433release<version>
<dependency>
<dependency>
<groupid>orgspringframeworkboot<groupid>
<artifactid>spring-boot-starter-test<artifactid>
<version>141release<version>
<dependency>
<dependency>
<groupid>iospringfox<groupid>
<artifactid>springfox-swagger2<artifactid>
<version>222<version>
<exclusions>
<exclusion>
<artifactid>spring-context<artifactid>
<groupid>orgspringframework<groupid>
<exclusion>
<exclusion>
<artifactid>spring-aop<artifactid>
<groupid>orgspringframework<groupid>
<exclusion>
<exclusion>
<artifactid>spring-beans<artifactid>
<groupid>orgspringframework<groupid>
<exclusion>
<exclusion>
<artifactid>spring-web<artifactid>
<groupid>orgspringframework<groupid>
<exclusion>
<exclusion>
<artifactid>spring-webmvc<artifactid>
<groupid>orgspringframework<groupid>
<exclusion>
<exclusion>
<artifactid>spring-core<artifactid>
<groupid>orgspringframework<groupid>
<exclusion>
<exclusion>
<artifactid>jackson-annotations<artifactid>
<groupid>comfasterxmljacksoncore<groupid>
<exclusion>
<exclusion>
<artifactid>slf4j-api<artifactid>
<groupid>orgslf4j<groupid>
<exclusion>
<exclusions>
<dependency>
<dependency>
<groupid>iospringfox<groupid>
<artifactid>springfox-swagger-ui<artifactid>
<version>222<version>
<dependency>
<dependencies>
第三步：在com目录或者其子目录下新建一个application类，如下图所示。注意一定要在com或其子目录下，否则启动不了。
application的代码如下 package com;
import orgspringframeworkbootspringapplication;
import orgspringframeworkbootautoconfigure
enableautoconfiguration;
import orgspringframeworkbootautoconfigure
springbootapplication;
import orgspringframeworkbootbuilder
springapplicationbuilder;
import orgspringframeworkbootwebsupport
springbootservletinitializer;
import springfoxdocumentationswagger2
annotationsenableswagger2;
**
* test-sc
* created by grady on 2017418
*
@enableswagger2
@springbootapplication
@importresource("classpath:meta-infspring
spring-dubbo-providerxml")
@enableautoconfiguration启用自动配置
@componentscan("comfilter,comcontroller,
commanager,comapiimpl")
public class application extends
springbootservletinitializer {
@override
protected springapplicationbuilder configure
(springapplicationbuilder application) {
return applicationsources(applicationclass);
}
public static void main(string[] args) {
springapplicationrun(applicationclass);
}
}
第四步：在controller中写接口 controller类代码如下 package comcontroller;
import ioswaggerannotationsapioperation;
import ioswaggerannotationsapiparam;
import orgspringframeworkwebbindannotationrequestmapping;
import orgspringframeworkwebbindannotationrequestmethod;
import orgspringframeworkwebbindannotationrequestparam;
import orgspringframeworkwebbindannotationrestcontroller;
**
* created by dell16 on 2017418
*
@requestmapping("ordernew")
@restcontroller
public class ordercontroller {
@apioperation(value = "获取某条订单信息")
@requestmapping(value = "getorder", method = requestmethodget)
public string getorder(@apiparam(value = "订单编号",required = true) @requestparam(value = "orderno") string orderno,
@apiparam(value = "当前页") @requestparam(value = "pagenum",required = false) integer pagenum,
@apiparam(value = "每页显示数量") @requestparam(value = "pagesize",required = false) integer pagesize) {
return "成功！";
}
}
有了上面这四步，启动这个工程，就可以输入:localhost:8080swagger-uihtml#!order-controllergetorderusingget来访问swagger页面了。