
课程咨询: 400-996-5531 / 投诉建议: 400-111-8989
认真做教育 专心促就业
随着互联网的不断发展,越来越多的人都在学习计算机编程开发技术,而今天我们就一起来了解一下,软件开发API设计都有哪些注意事项。
平台独立性。任何客户端都能消费API,而不需要关注系统内部实现。API应该使用标准的协议和消息格式对外部提供服务。传输协议和传输格式不应该侵入到业务逻辑中,也就是系统应该具备随时支持不同传输协议和消息格式的能力。
系统可靠性。在API已经被发布和非API版本改变的情况下,API应该对契约负责,不应该导致数据格式发生破坏性的修改。在API需要重大更新时,使用版本升级的方式修改,并对旧版本预留下线时间窗口。
API应该服务业务能力的封装,避免简单封装让API彻底变成了数据库操作接口。例如标记订单状态为已支付,应该提供形如POST/orders/1/pay这样的API。而非PATCH/orders/1,然后通过具体的字段更新订单。
业务变化可能修改API参数或响应数据结构,以及资源之间的关系。一般来说,字段的增加不会影响旧的客户端运行。但是当存在一些破坏性修改时,就需要使用新的版本将数据导向到新的资源地址。
安全是任何一项软件设计都必须要考虑的事情,对于API设计来说,暴露给内部系统的API和开放给外部系统的API略有不同。
【免责声明】:本内容转载于网络,转载目的在于传递信息。文章内容为作者个人意见,本平台对文中陈述、观点保持中立,不对所包含内容的准确性、可靠性与完整性提供形式地保证。请读者仅作参考。更多内容请在707945861群中学习了解。