服务接口编写规范总结(待完善)


1、实现接口   

  1)必须捕获异常。   

  2)长时间服务与短时间服务,采用不同阻塞机制。   

  3)返回结果要封装,支持执行成功失败,成功时可访问结果,失败时,返回失败信息。主要针对接口使用者。   

  4)接口必须记录输入、输出日志,执行时间。若执行时间超长,必须记录异常日志。   

  5)集合类参数,按业务要求限制数据量。

2、调用使用说明   

  1)调用方式,输入与返回结果说明,逻辑概要说明和重点注意说明,响应时长预期说明,是否抛出异常说明。   

  2)必须捕获异常,按业务需要和接口响应时间设定接口超时时间。   

  3)记录输入、输出日志,记录响应时长。