asp.net mvc rest WebApiCenter

1、技术架构

架构:asp.net mvc restful web api

前端框架:bootstrap

数据库:mongodb

2、数据库设计

表名:ApiLibrary Api库

ID ObjectId 主键

apiname string api名称

description api描述

docurl 接口文档地址

表名:Authorizations 权限授权表

ID ObjectId 主键

Apilibraryids api库id集合 用,分割

Clientsid 客户端ID

表名:Clients 客户端表

ID ObjectId 主键

Clientname 客户端名称

Clientid api_key

Clientsecret api_secret

Reqip 限制访问IP

Createtime 创建时间

Isenabled 状态(正常/暂停)

表名:Users 用户表

Account 账号

Password 密码

3、项目代码结构


4、控制中心页面


5、接口API规范

接口地址(正式环境):http://正式地址/api

调用方式:Get或Post皆可

接口参数:


返回代码:

在该文件夹下

6、接口调用示例

本例将以获取积分余额功能为例,讲解如何通过服务调用相应的数据,首先我们会提供给接口调用方,两个key文件,一个APIKey和一个SecretKey,还有一个apiid如本例中的

APIKEY:CEE4975F-8E59-4FB6-A1DD-D02EDA829342

SecretKey:3C3219B7CFEB89418259CB445AC33051

APIId:56b08a110ad8f94c50e6bf05

1、提供接口方法所需的特定参数(必填):

在Score.QueryScoreByMembercode这个积分查询接口方法中,membercode入参是必须的,在本例中分别对应138888888888,通过key=value的方式拼接参数字符串为:

method= Score.QueryScoreByMembercode&membercode=138888888888

2、加上其余可选参数(可根据需要选填):

method=Score.QueryScoreByMembercode&api_key=CEE4975F-8E59-4FB6-A1DD-D02EDA829342&membercode=138888888888

4、根据上面的字符串,加上secretkey值,用sh1算法加密得到sig的值

method=Score.Score.QueryScoreByMembercode&api_key=CEE4975F-8E59-4FB6-A1DD-D02EDA829342&membercode=138888888888

&api_id=56b08a110ad8f94c50e6bf05&3C3219B7CFEB89418259CB445AC33051

通过sha1算法加密上面的字符串,可以得到例如

sig=062A3A36C664FEFE0FD1472A7782969DF1AB0CF0

5、现在就可以通过完整的url,获取所需要的数据了:

正式地址/api?method=Score.QueryScoreByMembercode&api_key=CEE4975F-8E59-4FB6-A1DD-D02EDA829342&sig=062A3A36C664FEFE0FD1472A7782969DF1AB0CF0&membercode=13901648617&api_id=56b08a110ad8f94c50e6bf05

6、服务器返回的结果默认是Json,也可以是XML

7、QA

1、登录用户怎么增加

进入发布服务器下,在C:\Program Files (x86)\MongoDB 2.6 Standard\bin打开DOS命令窗口

输入mongod –dbpath “D:/Mongodb/DB”

然后重新打开新的dos命令窗口

输入mongo

然后输入use WebApiCenter(WebApiCenter即数据库)

然后输入db.Users.insert({account:”用户名”,password:”密码”})

即可

2、如何增加API类库

在APILirbry下增加类库

以及在mongodb中增加

db.ApiLibrary.insert({apiname:"MobileServices",description:"专为移动端开发的API",docid:""})

项目开源地址:https://github.com/liyunzhi1993/Asp.net-Mvc-Rest-WebApiCenter

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • REST API 可以让你用任何支持发送 HTTP 请求的设备来与 Parse 进行交互,你可以使用 REST A...
    Caroline嗯哼阅读 2,074评论 0 0
  • 一. Java基础部分.................................................
    wy_sure阅读 3,834评论 0 11
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,760评论 18 399
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,886评论 18 139
  • 感恩所有生命里遇见的亲们 收获如此丰盛 住了郭老师家一年的房子(郭姐不但包容超期两周,连看好房子着急来住的租客都婉...
    舍得_之间阅读 354评论 19 15