声明

readme.md

@@ -1,10 +1,11 @@
 # 帆软插件开发工具套件
 
+## 作用简介
 该套件在帆软工程类基础上做了二次封装，仅暴露接口，可以更好的兼容不同版本的非开放API。
 
 比如，要获取报表的会话信息，以前需要调用方法
 ```java
-SessionPoolManager#getSessionIDInfor(String sessionID, Class<T> clazz);
+SessionPoolManager#getSessionIDInfor(@NotNull String sessionID, Class<T> clazz);
 ```
 但可能随着版本的变更，SessionPoolManager变更了一个名字，比如由SessionPoolManager改成了NewSessionPoolManager，
 那么所有调用了该API的插件都无法使用，必须要重新修改插件中的该处代码并更新插件才行。
@@ -13,4 +14,9 @@ SessionPoolManager#getSessionIDInfor(String sessionID, Class<T> clazz);
 ```java
 SessionFactory#getSession(@NotNull String sessionID);
 ```
-仅仅只需要更新最新版本的开发套件工具包即可让老插件自然适配。
+仅仅只需要更新最新版本的开发套件工具包即可让老插件自然适配。
+
+## 提交新API要求
+
+* 所有的API方法的返回值和参数，仅允许使用基本类型或者接口类型。
+* 所有的API方法均需要有单元测试覆盖。