easy-api

什么样的场景需要easy-api？

 （1）作为接口调用方，我们希望接口提供方不只是提供苍白的接口文档，最好能提供一个可视化界面调用一下，这样我们就能快速定位是参数问题还是调用逻辑问题；
  （2）作为接口提供方，接口调用方固执的认为是你的服务出了问题，你可以根据他给的参数在可视化界面里调用你的接口，成功的返回了数据，然后狠狠的告诉对方是他的服务出错了。

    想想，如果真的有这样的工具，对于项目研发该有多大的帮助!接下来，我们一起揭开easy-api的神秘面纱。

介绍

    easy-api的主要目标是降低不同项目之间的对接成本问题，同时也能加速日常开发工作，服务对象是后端研发人员。它能做到：（1）只要你愿意，你可以给整个项目的代码生成文档（包括MVC任意一层，也包括dubbo等rpc服务）；（2）提供可视化调用界面，打开浏览器输入参数就能调试接口代码。从而快速定位问题，解决一天到晚找bug的烦恼。

基础功能

1.引用

新建maven项目引入easy-api依赖(点击 最新版本地址 查看最新版本)

<dependency>
    <groupId>io.github.xiaoyudeguang</groupId>
    <artifactId>easy-api</artifactId>
    <version>最新版本</version>
</dependency>

2.编码

package com.zlyx.demo.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping(value = "demo")
public class DemoController {

	@RequestMapping(value = "test")
	public Object test(String name, int age) {
		return EasyBuffer.at(name, age);
	}
}

package com.zlyx.demo.config;

import org.springframework.stereotype.Controller;

import com.zlyx.easyapi.annotations.ApiGroup;

@ApiGroup(todo = { "注册Api" }, group = "Controller文档", clses = { Controller.class })
public class ApiConfig {

}

3. 效果

如果没有意外的话，对于大多数人来说到这里已经够用了。只要修改ApiGroup的clses属性值(不止支持注解，也支持接口和普通java类)，就可以为MVC任意一层生成文档了。

高级功能

1. 注解的运用(任意一个接口或类都可以)

（1）好的框架离不开注解，easy-api也提供了注解支持。

package com.zlyx.demo.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import com.zlyx.easyapi.annotations.ApiDesc;
import com.zlyx.easycore.tool.EasyBuffer;

import io.swagger.annotations.ApiParam;

@ApiDesc(value = "DemoController", author = "赵光", leader = "赵光", date = "2019-08")
@Controller
@RequestMapping(value = "demo")
public class DemoController {

	@ApiDesc(value = "测试方法", author = "张三")
	@RequestMapping(value = "test")
	public Object test(@ApiParam("姓名") String name, @ApiParam("年龄") int age) {
		return EasyBuffer.at(name, age);
	}
}

 效果图：

（2）如果你是swagger注解深度用户，那么可以这么写，只是接口作者负责人那里会是默认值。

package com.zlyx.demo.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import com.zlyx.easycore.tool.EasyBuffer;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;

@Api("示例控制器")
@Controller
@RequestMapping(value = "demo")
public class DemoController {

	@ApiOperation(value = "测试方法")
	@RequestMapping(value = "test")
	public Object test(@ApiParam("姓名") String name, @ApiParam("年龄") int age) {
		return EasyBuffer.at(name, age);
	}
}

 效果图：

2. Spring之外

上面介绍了怎么给MVC任意一层生成文档，前提是必须是Spring的bean。如果不是Spring的bean呢？eas-api提供了一个扩展接口，修改上面的ApiConfig，让它实现扩展接口ApiRegister的register(）方法即可。以dubbo服务为例：

package com.zlyx.config;

import java.util.Map;
import java.util.Map.Entry;

import org.springframework.context.ApplicationContext;

import com.alibaba.dubbo.config.annotation.Service;
import com.alibaba.dubbo.config.spring.ServiceBean;
import com.zlyx.easyapi.annotations.ApiGroup;
import com.zlyx.easyapi.register.ApiRegister;
import com.zlyx.easycore.map.Maps;
import com.zlyx.easycore.utils.ProxyUtils;
import com.zlyx.easycore.utils.SpringUtils;

@ApiGroup(todo = { "" }, clses = { Service.class })
public class ApiConfig implements ApiRegister {

	@SuppressWarnings("rawtypes")
	@Override
	public Map<Class<?>, Object> register(ApplicationContext applicationContext) {
		Map<Class<?>, Object> beansMap = Maps.newHashMap();
		Map<String, ServiceBean> beans = SpringUtils.getBeansOfType(ServiceBean.class);
		if (beans != null && beans.size() > 0) {
			for (Entry<String, ServiceBean> entry : beans.entrySet()) {
				beansMap.put(((ServiceBean<?>) entry.getValue()).getInterfaceClass(),
						ProxyUtils.getTarget(entry.getValue().getRef()));
			}
		}
		return beansMap;
	}
}

喜欢的话，到码云 https://gitee.com/xiaoyudeguang/easy-api 加个star呗