开发者社区> yichudu> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

swagger (可视化RESTful API的工具)

简介: swagger 是一个可视化RESTful WebService的工具。 官网:http://swagger.io 效果 下图可以看出,swagger清晰地展现了web服务的方法、地址、发送json格式与应答json格式。还可以通过它直接进行服务调用,查看结果。 图1 swagger的效果 工作原理 视图部分: swagger-ui是一系列css\js资源,它通过html页
+关注继续查看

swagger 是一个可视化RESTful WebService的工具。

官网:http://swagger.io

效果

下图可以看出,swagger清晰地展现了web服务的方法、地址、发送json格式与应答json格式。还可以通过它直接进行服务调用,查看结果。


图1 swagger的效果

工作原理

视图部分: swagger-ui是一系列css\js资源,它通过html页面向用户展示一个应用的RESTful API信息。它通过向swagger-core后台模块发送ajax请求获取必要的信息。

其实就是一个json,我们可以截取一点来看看:

//swagger.json 示例
{
	"swagger": "2.0",
	"info": {
		"version": "1.0.0",
		"title": ""
	},
	"host": "localhost:8080",
	"basePath": "/webService",
	"tags": [{
		"name": "hello"
	}],
	"schemes": ["http"],
	"paths": {
		"/helloworld": {
			"get": {
				"tags": ["hello"],
				"operationId": "wsHello",
				"parameters": [],
				"responses": {
					"200": {
						"description": "successful operation",
						"schema": {
							"type": "string"
						},
						"headers": {
							
						}
					}
				}
			}
		}
	}
}


后台部分:swagger-core通过 io.swagger.annotations.Api等注解感知到我们的API信息,从而以json格式应答web页面的ajax请求。

服务器部分:可以在tomcat中用。


与jersey集成部署

jersey在tomcat中的配置太灵活了,可以写在web.xml中作servlet,也可以作filter,还可以在java代码中继承某个类,更可以继承相关的其他类!以下是我试验成功的一种情况。
1.Adding the dependencies to your application
<dependency>
	<groupId>io.swagger</groupId>
	<artifactId>swagger-jersey2-jaxrs</artifactId>
	<version>1.5.0</version>
</dependency>

2.Hooking up Swagger-Core in your Application
即让jersey感知到swagger的存在。
public class App extends ResourceConfig {
	public App() {
		// 向jersey框架注册资源类,凡完全限定名是以指定字符串开头的类,都将包含
		packages("com.likeyichu.webservice.resource");
		register(JacksonFeature.class);
		//swagger
		Set<Class<?>> resources = new HashSet<>();
	    resources.add(io.swagger.jaxrs.listing.ApiListingResource.class);
        resources.add(io.swagger.jaxrs.listing.SwaggerSerializers.class);
		registerClasses(resources);
	}
}

3.Configure and Initialize Swagger

添加servlet即可,主要是为了配置我们api的地址,因为swagger可以发送请求的。

  <servlet>
        <servlet-name>Jersey2Config</servlet-name>
        <servlet-class>io.swagger.jersey.config.JerseyJaxrsConfig</servlet-class>
        <init-param>
            <param-name>api.version</param-name>
            <param-value>1.0.0</param-value>
        </init-param>
        <init-param>
            <param-name>swagger.api.basepath</param-name>
            <param-value>http://localhost:8080/webService/api</param-value>
        </init-param>
        <load-on-startup>2</load-on-startup>
    </servlet>

配置完成,即可在浏览器地址栏中输入webservice目录\swagger.json进行验证。

4.前端资源

github上的swaggerUI项目就是,下载下来就好。注意要改index.html,里面swagger.json的地址指向自己的就好。

常见异常

微笑现象:无穷递归早成栈溢出。
代码:
@Api(value="swagger test")
@Path("book")
@JsonAutoDetect
@JsonPropertyOrder(value = {"price", "name"})
@JsonIgnoreProperties(value = {"year"})
public class Book {
	@JsonProperty("name1")
	public String name = "Physics";
	public String price = "123";
	public String year = "2015";
	@GET
	@Produces(MediaType.APPLICATION_JSON)
	public Book wsBook(){
		return new Book();
	}
}

微笑原因:swagger在进行资源扫描的时候有以下步骤:
1.因为@Api注解找到了Book类;
2.发现了类下的wsBook()这个函数,它的返回值是Book对象,于是查看它的类有没有@Api注解。发现有,转入步骤1。
于是就造成了无穷递归。
解决办法是资源类不当做Pojo用。


版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
Restful API设计指南
Restful API设计指南
82 0
RESTful API 设计指南
来源:http://www.ruanyifeng.com/blog/2014/05/restful_api.html 网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)。
758 0
RESTful API 设计指南
  作者: 阮一峰   网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)。   因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。
1095 0
RESTful API如何进行版本控制
本文将帮助您理解为什么需要版本控制,以及如何对REST API进行版本控制。我们将讨论4种版本控制的方法,并比较不同的方法。
145 0
RESTful API系列 - RESTful API是什么以及其设计要点
目录 REST API是什么? No.1 数据跟界面解耦合 No.2 无状态 No.3 可缓存 No.4 统一接口/标准化接口 No.5 分层次系统风格 No.6 按需编码(可选)
72 0
根据豆瓣 API 理解Restful API
  1.什么是REST   REST全称是Representational State Transfer,表述状态转移的意思。它是在Roy Fielding博士论文首次提出。REST本身没有创造新的技术、组件或服务,它的理念就是在现有的技术之上,更好的使用现有的 web规范。用REST规范的web服务器,能够更好的展现资源,客户端能够更好的使用资源。每个资源都由URI/ID标识。REST本身跟http无关,但是目前http是与它相关的唯一实例。REST有着优雅、简洁的特性,本文是根据豆瓣api来谈谈自己对restful的一些理解。
207 0
REST与RESTFul API最佳实践
RESTFul API已经是现在互联网里对外开放接口的主流模式
5676 0
+关注
618
文章
1
问答
文章排行榜
最热
最新
相关电子书
更多
低代码开发师(初级)实战教程
立即下载
阿里巴巴DevOps 最佳实践手册
立即下载
冬季实战营第三期:MySQL数据库进阶实战
立即下载