webapi接口设计（webapi设计规范）

网友投稿 503 2023-03-12


本篇文章给大家谈谈webapi接口设计，以及webapi设计规范对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。 今天给各位分享webapi接口设计的知识，其中也会对webapi设计规范进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

怎样操作WebAPI接口

先定义一个简单的webapiwebapi接口设计，简单到差不多直接用vs2010自动生成的webapi代码。
其中的TestModle是一个简单的classwebapi接口设计，如下
public class TestModle
{
public string a { get; set; }
public string b { get; set; }
public string c { get; set; }
}
前端页面放四个代表get，post，put，delete的按钮，在加一个div显示返回值
前端代码中加载jquery，在定义四个按钮的click事件
get和post，webapi接口设计我习惯用$.get和$.post，当然也能用$.ajax.
get直接返回webapi get的return值，post的话我就不在后端做处理webapi接口设计了直接返回传入的值，这里只做示范
put和delete，只能用$.ajax来处理。
put的话一般用于update某个id的数据信息
delete用于删除某个id的数据，如下图所示
点击每个按钮，可以在页面上看到相应的效果

App 和 Web 的通用接口该怎么设计

1、在接口定义中确定MVC的GET或者POST方式
由于我们整个Web API平台是基于MVC的基础上进行的API开发，因此整个Web API的接口，在定义的时候，一般需要显示来声明接口是[HttpGet]或者[HttpPost]，虽然有些接口也可以不用声明，但是避免出现类似下面的错误信息，显式声明还是有好处的。
请求的资源不支持 http 方法“POST
例如在基类定义的查找对象接口如下所示。
/// <summary
/// 查询数据库,检查是否存在指定ID的对象
/// </summary
/// <param name="id"对象的ID值</param
/// <returns存在则返回指定的对象,否则返回Null</returns
[HttpGet]
public virtual T FindByID(string id, string token)
如果是增删改的接口，一般需要声明为POST方式提交数据，而且基于安全性的考虑，需要携带更多的参数。
/// <summary
/// 插入指定对象到数据库中
/// </summary
/// <param name="info"指定的对象</param
/// <returns执行操作是否成功。</returns
[HttpPost]
public virtual CommonResult Insert(T info, string token, string signature, string timestamp, string nonce, string appid)
2、动态对象的接口定义
在一般的Web API接口里面，我们可能都会碰到很多简单类型的参数，但是又想让它们以POST方式提交数据，那么我们就可以有两种方法来处理，一种是定义一个类来放置这些参数，一种是采用动态的JObject参数，前者有很多不方便的地方，因为我们不可能为每个接口参数定义多一个实体类，这样可能会有很多难以管理的类定义。如下面是微信API的调用接口案例，我们也需要设置这样的处理规则。
接口调用请求说明
http请求方式: POST（请使用https协议）
https://api.weixin.qq.com/cgi-bin/groups/update?access_token=ACCESS_TOKEN
POST数据格式：json
POST数据例子：{"group":{"id":108,"name":"test2_modify2"}}
那么我们采用JObject是这么样的呢，我们来看接口的定义和处理代码。JObject是Newtonsoft.Json.Linq命名空间下的一个对象。
/// <summary
/// 修改用户密码
/// </summary
/// <param name="param"包含userName和userPassword的复合对象</param
/// <param name="token"用户访问令牌</param
/// <returns</returns
[HttpPost]
public CommonResult ModifyPassword(JObject param, string token)
{
//令牌检查,不通过则抛出异常
CheckResult checkResult = CheckToken(token);
dynamic obj = param;
if (obj != null)
{
string userName = obj.userName;
string userPassword = obj.userPassword;
bool success = BLLFactory<User.Instance.ModifyPassword(userName, userPassword);
return new CommonResult(success);
}
else
{
throw new MyApiException("传递参数出现错误");
}
}
其中我们把JObject对象转换为我们所需要的对象的时候，因为我们没有定义具体的实体类，因此采用了dynamic语法，声明这是一个动态对象，由运行时获取对应的属性。
dynamic obj = param;
这样我们就可以在调用的时候，动态POST对应的JSON对象给Web API接口，而不需要预先定义各种接口参数的类了。
/// <summary
/// 调用Web API接口，修改用户密码
/// </summary
/// <param name="userName"用户名称</param
/// <param name="userPassword"修改的密码</param
/// <returns如果修改成功返回true，否则返回false</returns
public bool ModifyPassword(string userName, string userPassword)
{
var action = "ModifyPassword";
var postData = new
{
userName = userName,
userPassword = userPassword
}.ToJson();
string url = GetTokenUrl(action);
CommonResult result = JsonHelper<CommonResult.ConvertJson(url, postData);
return (result != null) ? result.Success : false;
}
其中GetTokenUrl是根据token和API的地址等参数，构建一个完整的提交地址。我们在上面代码通过
var postData = new
{
userName = userName,
userPassword = userPassword
}.ToJson();
就可以动态创建一个对象，并生成它的JSON字符串，把数据POST提交到对应的API接口里面即可，然后对结果进行对象的转换就算完成了。
3、集合和分页的处理
在很多接口里面，我们都需要用到分页的处理，Web API也不例外，这样可以提交数据检索效率，减少服务器数据处理的压力，同时也提交客户端的数据显示速度。
一般的集合接口定义如下所示（通用性基类接口）。
/// <summary
/// 返回数据库所有的对象集合
/// </summary
/// <returns指定对象的集合</returns
[HttpGet]
public virtual List<T GetAll(string token)
{
//检查用户是否有权限，否则抛出MyDenyAccessException异常
base.CheckAuthorized(AuthorizeKey.ListKey, token);
List<T list = baseBLL.GetAll();
return list;
}
但是这样的返回记录会比较多，一般情况下需要分页，那么分页的处理接口定义如下所示。
/// <summary
/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
/// </summary
/// <returns指定对象的集合</returns
[HttpPost]
public virtual PagedList<T FindWithPager(string condition, PagerInfo pagerInfo, string token)
分页接口，在这里返回的结果里面，用了一个PageList的泛型类，这个方便我们获取当前的记录及总数，它的定义如下所示。
/// <summary
/// 分页集合
/// </summary
/// <typeparam name="T"对象</typeparam
public class PagedList<T
{
/// <summary
/// 返回记录的总数
/// </summary
public int total_count { get; set; }
/// <summary
/// 列表集合
/// </summary
public List<T list { get; set; }
}
最后整个分页的处理Web API接口实现如下所示。
/// <summary
/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
/// </summary
/// <returns指定对象的集合</returns
[HttpPost]
public virtual PagedList<T FindWithPager(string condition, PagerInfo pagerInfo, string token)
{
//检查用户是否有权限，否则抛出MyDenyAccessException异常
base.CheckAuthorized(AuthorizeKey.ListKey, token);
List<T list = baseBLL.FindWithPager(condition, pagerInfo);
//构造成Json的格式传递
var result = new PagedList<T() { total_count = pagerInfo.RecordCount, list = list };
return result;
}
最后客户端调用分页的Web API代码如下所示。
/// <summary
/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
/// </summary
/// <param name="condition"查询的条件</param
/// <param name="pagerInfo"分页实体</param
/// <returns指定对象的集合</returns
public virtual List<T FindWithPager(string condition, ref PagerInfo pagerInfo)
{
var action = "FindWithPager";
string url = GetTokenUrl(action) + string.Format("condition={0}", condition);
var postData = pagerInfo.ToJson();
List<T result = new List<T();
PagedList<T list = JsonHelper<PagedList<T.ConvertJson(url, postData);
if (list != null)
{
pagerInfo.RecordCount = list.total_count;//修改总记录数
result = list.list;
}
return result;
}
4、混合框架界面整合Web API接口
在整个Web API的平台构建以及在混合框架的整合过程中，我把各个模块还是遵循相对独立的方式进行开发和整合，它们实现了从直接访问数据库、以WCF服务获取数据，以及通过WebAPI调用方式获取数据几种方式的统一，从而实现了整个混合框架的高度整合。
整个混合框架的核心是以相对独立的方式，整合各个可重用的模块，我们可以遵循一定的基础上，快速构建统一的应用平台。
搭建完毕的整个WebAPI平台，其中包括了服务端内容，以API控制器的方式，发布了对应的Web API接口。
在每个混合框架的独立模块里面，我们封装了对应的Web API客户端调用处理，从而实现了Web API的调用方式。
在Win10下，使用Web API模式运行混合框架，获得的主体界面效果如下所示。
独立模块权限管理系统界面如下所示。
系列文章如下所示：
Web API应用架构在Winform混合框架中的应用（1）
Web API应用架构在Winform混合框架中的应用（2）--自定义异常结果的处理
Web API接口设计经验总结
Web API应用架构在Winform混合框架中的应用（3）--Winfrom界面调用WebAPI的过程分解
Web API应用架构在Winform混合框架中的应用（4）--利用代码生成工具快速开发整套应用
Web API应用架构在Winform混合框架中的应用（5）--系统级别字典和公司级别字典并存的处理方式

用户提交订单 上传地理位置 接口怎么设计

1、接口定义确定MVCGET或者POST式
由于我整Web API平台基于MVC基础进行API发整Web API接口定义候般需要显示声明接口[HttpGet]或者[HttpPost]虽些接口用声明避免现类似面错误信息显式声明处
请求资源支持 http POST
例基类定义查找象接口所示
///
/// 查询数据库,检查否存指定ID象
///
/// 象ID值
/// 存则返指定象,否则返Null
[HttpGet]
public virtual T FindByID(string id, string token)
增删改接口般需要声明POST式提交数据且基于安全性考虑需要携带更参数
///
/// 插入指定象数据库
///
/// 指定象
/// 执行操作否功
[HttpPost]
public virtual CommonResult Insert(T info, string token, string signature, string timestamp, string nonce, string appid)
2、态象接口定义
般Web API接口面我能都碰简单类型参数想让POST式提交数据我两种处理种定义类放置些参数种采用态JObject参数前者便我能每接口参数定义实体类能难管理类定义面微信API调用接口案例我需要设置处理规则
接口调用请求说明
http请求式: POST（请使用https协议）
POST数据格式：json
POST数据例：{"group":{"id":108,"name":"test2_modify2"}}
我采用JObject呢我看接口定义处理代码JObjectNewtonsoft.Json.Linq命名空间象
///
/// 修改用户密码
///
/// 包含userNameuserPassword复合象
/// 用户访问令牌
///
[HttpPost]
public CommonResult ModifyPassword(JObject param, string token)
{
//令牌检查,通则抛异
CheckResult checkResult = CheckToken(token);
dynamic obj = param;
if (obj != null)
{
string userName = obj.userName;
string userPassword = obj.userPassword;
bool success = BLLFactory.Instance.ModifyPassword(userName, userPassword);
return new CommonResult(success);
}
else
{
throw new MyApiException("传递参数现错误");
}
}
其我JObject象转换我所需要象候我没定义具体实体类采用dynamic语声明态象由运行获取应属性
dynamic obj = param;
我调用候态POST应JSON象给Web API接口需要预先定义各种接口参数类
///
/// 调用Web API接口修改用户密码
///
/// 用户名称
/// 修改密码
/// 修改功返true否则返false
public bool ModifyPassword(string userName, string userPassword)
{
var action = "ModifyPassword";
var postData = new
{
userName = userName,
userPassword = userPassword
}.ToJson();
string url = GetTokenUrl(action);
CommonResult result = JsonHelper.ConvertJson(url, postData);
return (result != null) ? result.Success : false;
}
其GetTokenUrl根据tokenAPI址等参数构建完整提交址我面代码通
var postData = new
{
userName = userName,
userPassword = userPassword
}.ToJson();
态创建象并JSON字符串数据POST提交应API接口面即结进行象转换算完
3、集合页处理
接口面我都需要用页处理Web API例外提交数据检索效率减少服务器数据处理压力同提交客户端数据显示速度
般集合接口定义所示（通用性基类接口）
///
/// 返数据库所象集合
///
/// 指定象集合
[HttpGet]
public virtual List GetAll(string token)
{
//检查用户否权限否则抛MyDenyAccessException异
base.CheckAuthorized(AuthorizeKey.ListKey, token);
List list = baseBLL.GetAll();
return list;
}
返记录比较般情况需要页页处理接口定义所示
///
/// 根据条件查询数据库,并返象集合(用于页数据显示)
///
/// 指定象集合
[HttpPost]
public virtual PagedList FindWithPager(string condition, PagerInfo pagerInfo, string token)
页接口返结面用PageList泛型类便我获取前记录及总数定义所示
///
/// 页集合
///
/// 象
public class PagedList
{
///
/// 返记录总数
///
public int total_count { get; set; }
///
/// 列表集合
///
public List list { get; set; }
}
整页处理Web API接口实现所示
///
/// 根据条件查询数据库,并返象集合(用于页数据显示)
///
/// 指定象集合
[HttpPost]
public virtual PagedList FindWithPager(string condition, PagerInfo pagerInfo, string token)
{
//检查用户否权限否则抛MyDenyAccessException异
base.CheckAuthorized(AuthorizeKey.ListKey, token);
List list = baseBLL.FindWithPager(condition, pagerInfo);
//构造Json格式传递
var result = new PagedList() { total_count = pagerInfo.RecordCount, list = list };
return result;
}
客户端调用页Web API代码所示
///
/// 根据条件查询数据库,并返象集合(用于页数据显示)
///
/// 查询条件
/// 页实体
/// 指定象集合
public virtual List FindWithPager(string condition, ref PagerInfo pagerInfo)
{
var action = "FindWithPager";
string url = GetTokenUrl(action) + string.Format("condition={0}", condition);
var postData = pagerInfo.ToJson();
List result = new List();
PagedList list = JsonHelper<PagedList.ConvertJson(url, postData);
if (list != null)
{
pagerInfo.RecordCount = list.total_count;//修改总记录数
result = list.list;
}
return result;
}
4、混合框架界面整合Web API接口
整Web API平台构建及混合框架整合程我各模块遵循相独立式进行发整合实现直接访问数据库、WCF服务获取数据及通WebAPI调用式获取数据几种式统实现整混合框架高度整合
整混合框架核相独立式整合各重用模块我遵循定基础快速构建统应用平台
搭建完毕整WebAPI平台其包括服务端内容API控制器式发布应Web API接口
每混合框架独立模块面我封装应Web API客户端调用处理实现Web API调用式
Win10使用Web API模式运行混合框架获主体界面效所示
独立模块权限管理系统界面所示
系列文章所示：
Web API应用架构Winform混合框架应用（1）
Web API应用架构Winform混合框架应用（2）--自定义异结处理
Web API接口设计经验总结
Web API应用架构Winform混合框架应用（3）--Winfrom界面调用WebAPI程解
Web API应用架构Winform混合框架应用（4）--利用代码工具快速发整套应用
Web API应用架构Winform混合框架应用（5）--系统级别字典公司级别字典并存处理式

java webapi接口怎么写

package com.dataMonitor.bo.common;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import net.sf.json.JSONObject;
import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import org.apache.http.HttpEntity; 关于webapi接口设计和webapi设计规范的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 webapi接口设计的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于webapi设计规范、webapi接口设计的信息别忘了在本站进行查找喔。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。

标签：接口设计 api 接口 控制 集合
上一篇:api接口文档输出（api接口文档是干什么的）
下一篇:接口联调测试用例（接口联调跟接口测试）
相关文章

 发表评论

暂时没有评论，来抢沙发吧~