接口设计指南

Posted zzfx

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了接口设计指南相关的知识,希望对你有一定的参考价值。

1)接口的名称能够反映API实现的功能,并且尽可能简洁。

2)接口的参量,完成接口服务请求的最少参量,需要精心组织。

3)接口的防御性编程,要完成参量的合法性检查。

 

每一个接口都代表一个服务,接口的调用就是服务请求的过程,请求的时候需要发送请求参量,也就是接口的参量。

请求的结果可以同步或移步返回。

以上是关于接口设计指南的主要内容,如果未能解决你的问题,请参考以下文章

组件接口(API)设计指南[2]-类接口(class interface)

API设计指南-「干货」一个接口文档模板的最佳实践

API设计指南 一个接口文档模板的最佳实践

组件接口(API)设计指南[4]-通知(Notifications)

ODS设计指南

ZYNQ 设计指南