接口设计指南

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

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

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

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

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

时间: 2024-10-03 21:56:03

接口设计指南的相关文章

组件接口(API)设计指南-目录

组件接口(API)设计指南-目录 组件接口(API)设计指南[1]-要考虑的问题 组件接口(API)设计指南[2]-类接口(class interface)  (排版中,待续) 组件接口(API)设计指南[3]-委托(delegate)和数据源协议(data-source protocols)  (排版中,待续) 组件接口(API)设计指南[4]-通知(Notifications)  (排版中,待续) 组件接口(API)设计指南[5]-最后的思考  (排版中,待续) 快速摘要: 译者注: 原文中

组件接口(API)设计指南-文件夹

组件接口(API)设计指南-文件夹 组件接口(API)设计指南[1]-要考虑的问题 组件接口(API)设计指南[2]-类接口(class interface) 组件接口(API)设计指南[3]-托付(delegate)和数据源协议(data-source protocols) 组件接口(API)设计指南[4]-通知(Notifications) 组件接口(API)设计指南[5]-最后的思考 高速摘要: 译者注: 原文中"delegate"译为中文"托付/代理",含义

来自HeroKu的HTTP API 设计指南(中文版)

原文转自:http://get.jobdeer.com/343.get 来自HeroKu的HTTP API 设计指南(中文版) 翻译 by @Easy 简介 本指南中文翻译者为 @Easy ,他是国内首家互联网人才拍卖网站 JobDeer.com 的创始人.转载请保留本信息. 本指南描述了一系列 HTTP+JSON API 的设计实践, 来自并展开于 Heroku Platform API 的工作.本指南指导着Heroku内部API的开发,我们希望也能对Heroku以外的API设计者有所帮助.

规范抢先看!微信小程序的官方设计指南和建议

基于微信小程序轻快的特点,我们(微信官方)拟定了小程序界面设计指南和建议. 设计指南建立在充分尊重用户知情权与操作权的基础之上.旨在微信生态体系内,建立友好.高效.一致的用户体验,同时最大程度适应和支持不同需求,实现用户与小程序服务方的共赢. 说到设计规范,这里有一篇绝对不能错过的:<内部教程!超实用6步透视网易设计规范(附完整PDF下载)> 一.友好礼貌 为了避免用户在微信中使用小程序服务时,注意力被周围复杂环境干扰,小程序在设计时应该注意减少无关的设计元素对用户目标的干扰,礼貌地向用户展示

边界接口设计

用户交互设计原则.模板 分离具体业务,基于认知规律,抽象出通用指导原则. 总体原则 l  心智模型:感知:理解:目标.计划.执行.解惑.总结: l  一致性:习惯.操作系统.品牌识别.关联软件.软件内部 感知体验 原则:简洁.对比.流畅 视觉:配色.布局.排版.动画 媒体:文字.图像.音视频 交互:键鼠.触摸.手势 理解内容 原则:降低复杂度 主次:重要(基本).次要(详细) 分组:同类信息 分层:面向用户.面向设备 联想:运用比喻.类比辅助理解 任务处理 原则:站在用户角度(使用用户语言.工作

微信小程序-设计指南

基于微信小程序轻快的特点,官方拟定了小程序界面设计指南和建议,可作为小程序开发参考. 友好礼貌 -避免用户使用服务时被周围环境干扰,设计时应减少无关设计对用户的影响,礼貌的向用户提供服务,友好的引导用户进行操作. 重点突出  -每个页面都应该有明确的重点,方便用户进入页面时可以快速理解页面内容 -明确重点,避免页面出现与用户决策和操作无关的干扰因素 流程明确 -为了用户体验,使其操作顺畅,应避免出现用户目标流程之外的内容而打断用户 清晰明确 -用户进入页面,我们就有责任和义务清晰明确的告知用户身

RS-485接口电路指南(TI:SLLA036D)

        摘要:本设计指南讨论如何设计RS-485接口电路.文中讨论了平衡传输线标准的必要性,并给出了一个过程控制设计例子.文中还分标题讨论了线路负载.信号衰减.失效保护和电流隔离. 1. 为什么需要平衡传输线标准 本文的重点在于工业最广泛使用的平衡传输线标准:ANSI/TIA/EIA-485-A(以下简称485).在回顾一些485标准的关键方面后,通过一个工厂自动化例子,介绍实际项目中如何实施差分传输结构. 远距离.高噪声环境下,计算机组件和外设之间的数据传输通常是困难的,如果有可能的话

Xilinx FPGA控制器的Everspin STT-DDR4设计指南

自旋转移扭矩磁阻随机存取存储器(STT-MRAM)是一种持久性存储技术,可利用各种工业标准接口提供了性能,持久性和耐用性. Everspin推出了STT-MRAM产品,该产品利用称为JE-DDR4的JEDEC标准DDR4接口的变体,它包含了对完整系统支持所需的独特功能.本文将帮助工程师了解Xilinx FPGA控制器的Everspin STT-DDR4设计指南 2.启用ST-DDR4为了使设计人员能够快速集成ST-DDR4支持,该过程从Xilinx Vivado开发环境中生成的现有8Gb DDR

微信小程序的Web API接口设计及常见接口实现

微信小程序给我们提供了一个很好的开发平台,可以用于展现各种数据和实现丰富的功能,通过小程序的请求Web API 平台获取JSON数据后,可以在小程序界面上进行数据的动态展示.在数据的关键 一环中,我们设计和编写Web API平台是非常重要的,通过这个我们可以实现数据的集中控制和管理,本篇随笔介绍基于Asp.NET MVC的Web API接口层的设计和常见接口代码的展示,以便展示我们常规Web API接口层的接口代码设计.参数的处理等内容. 1.Web API整体性的架构设计 我们整体性的架构设计