API开发实践 结构设计

Posted 知止

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了API开发实践 结构设计相关的知识,希望对你有一定的参考价值。

参加了2017年的阿里云API创新大赛,自己一个人参加的第一赛段,把开发过程中的学到的知识总结一下。

我设计的API功能:用户输入自己货物的订单编号及公司编号,返回物流信息地图。

实现方法:调用两个API,一个是快递鸟快递查询API,一个是高德地图地图查询API,利用servlet处理上传的数据并返回一个html显示地图。

开发模式:JavaBean+servlst+html

开发工具:阿里云服务器、Tomcat、MyEclipse、org.json.jar

 

功能模块:

接受url请求

调用快递鸟API进行查询

生成可显示地图的String型HTML并返回

 

文件夹及组织结构

 

servlet包:

getMap类--->接受客户端的url请求,处理并返回信息。

 

util包:

errorManage--->错误处理类,一个用来保存错误信息的类(实际上当做一种结构体来用)。

getHtml--->根据服务器处理的信息生成html格式的String。

kdniaoTrackQueryAPI--->物流查询类,包含快递鸟API查询请求的方法。

 

以上是关于API开发实践 结构设计的主要内容,如果未能解决你的问题,请参考以下文章

API设计与开发之最佳实践

API设计与开发实践第3篇 API 模型初探,从洋葱模型到细胞模型

谈谈前后端分离实践中如何提升RESTful API开发效率

有没有想过?前后端分离实践中如何提升 API 开发效率 ?

API开发实践 查询物流路径

服务API版本控制设计与实践