Restful API 接口模板化化生产和管理 (2)

需求的背景

** 核心resutful api 定义示例如下: **

  • URL: /api/queryUsers
  • 请求参数:
{
  "pageNum":1,  // 页码
  "pageSize":10, // 每页条数
  "userId":1,       //  用户Id
  "userName":"aaa",// 用户名称
  "appId":[1,2,3],   // 使用平台
  "orderByColumn":"usedId desc"  // 以userId 进行倒序
}
  • 响应结果:
{
  "status":0,        // 响应码 
  "pageNum":1,  // 页码数
  "pageSize":10, // 每页条数
  "pageTotail":10, // 总页面数
  "rowTotail":100,   // 总记录数 
  "users":   // 用户列表
      [
        {"userId":1,"userName":"aaaa","appId":[1,2,3]},
        {"userId":2,"userName":"bbbb","appId":[1,]},
        {"userId":3,"userName":"cccc","appId":[1,2,3]},
        ......
      ]  
}

** 业务api定义如下 **

  • URL:/api/isExistUser // 查询用户是否存在
req:
{
"userId":"111" // 用户Id
}
resp:
{
"status":0,  //结果0存在,其他:不存在
"resson:"sfdf" // 错误描述
}
  • URL:/api/getUserInfo // 查询指定用户信息(针对指定平台)
req: // 可针对用户id和用户名称进行查询,两个参数非必填
{
"userId":"111", // 用户Id
"userName": "aaaa" // 用户名称
}
resp:
{
"status":0,  //结果0存在,其他:不存在
"resson:"sfdf" // 错误描述
"user":{"userId":1,"userName":"aaaa","appId":[1,2,3]}
}

简单来说就是讲queryUsers转换为isExistUser和getUserInfo;isExistUser和getUserInfo实现其实都比较简单,无非就是修改下传入的参数和结果;
你可能会问这么简单的业务为啥还要包装呢?对外调用方直接修改参数不就行了?其实核心接口会随着业务增长开始增加接口或是对现有接口进行新参数的补充,调用方往往不会去全面评估说我们需要怎么传入参数,而是直接问你是这样传入么?业务接口做的其实就是外延把之前定义属于他们的管理的范围纳入到自己管理中避免上线出现业务业务对接出现问题。
随着对接方增加或是新业务增加,业务接口的数量也会开始增加;那么对业务接口也就需要管理体系对业务接口进行控制(核心接口的数量低于业务接口很多的,因为新合作方接入是常态肯定一下加3个合作方,每个合作方至少3个接口改造就9个了)

需要解决的问题:

OK,理清需求背景,我们现在做下需求的定位,也就是我们需要什么;
看如上的需求我需要的是两个东西:

  1. 业务接口的管理工具
  2. 核心接口转业务接口的工具
  • 业务接口管理工具包括:对业务接口进行定义接口,查询接口,删除接口,生成接口定义代码
  • 核心接口转业务接口的工具包括:
根据上第一篇需求进行项目设计如下图:
设计图初稿
设计图说明:
  • 场景1: 程序猿定义可直接生产服务端源码;
  • 此功能为能生成服务源码(包括业务),需要在定义过程中基本的Restful api定义(出参,入参),还需要对入参进行校验定义,出参肯定出现合并定义定工作。
  • 程序猿通过接口定义模块进行接口的定义的编辑工作,根据接口定义生成出对应的RestFul API接口(JSP源码),然后对JSP源码进行入库操作
    • 场景2:程序猿自定义接口;
  • 此场景也必须依赖场景1的定义,生成基本的jsp源码,再通过编辑修改此jsp源码完成自定义功能;
  • 程序猿通过接口源码模块获取到已经生成好的RestFul API接口进行,对JSP接口源码进行手工编码后将
    • 场景3:业务调用接口,会先进入web的filter进行url的匹配过程,通过url获取到最新执行的源码,并在本地生产JSP源文件,最后调用此jsp返回执行结果
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容