一种web接口命名定义

开头直接给网站,阮一峰老师介绍东西就是到位:http://www.ruanyifeng.com/blog/2011/09/restful.html

当然了规范归规范,但是大家在实际工作中,为了方便自己项目的开发,会结合自己情况,对规范做出调整形成自己的接口模式,

毕竟没有硬性要求。

下面介绍一下自己一套定义方式: 

①:定义两种请求类型:get(查询),post(增,删,改)

②:路径命名规范: 全部小写,禁止大写和下划线

         错误示范:

          http:://127.0.0.1/api/v1/content/wordList?id=1

          http:://127.0.0.1/api/v1/content/word_list?id=1

③:显式的标志出是什么请求(毕竟比让人看get请求这种隐式的规范才知道是查询来的实在)

        显式标识动词:

        新增:add        

        更新:update

        删除:delete

        查询:get

        http:://127.0.0.1/api/v1/content/word/getlist?wordId=1   或者   http://127.0.0.1/api/v1/content/getwordlist?wordId=1

        http:://127.0.0.1/api/v1/content/word/add   或者   http://127.0.0.1/api/v1/content/addword

        http:://127.0.0.1/api/v1/content/word/update或者   http://127.0.0.1/api/v1/content/updateword

        http:://127.0.0.1/api/v1/content/word/delete或者   http://127.0.0.1/api/v1/content/deleteword

        如果是批量修改:

        http:://127.0.0.1/api/v1/content/words/update或者   http://127.0.0.1/api/v1/content/updatewords

④:禁止使用无意义的单词,例如:index,event,home.类似这种

        http:://127.0.0.1/api/v1/content/index

        http:://127.0.0.1/api/v1/content/xxxxx

⑤:版本化

        加个v1,v2,什么的,这个东西很有必要,就是在迭代或者更换接口的时候很有好处

备注:

参加其他各大服务商提供出来的api接口,对比了一下,种类很多如下,目测没有什么规律可言,如果你有好的资料或者想法请留言交流哈。

http://japi.juhe.cn/enterprise/getDetailByName

http://v.juhe.cn/shortLetter/submitTpl.php

http://op.juhe.cn/jiepai/oilcardrr/onlineorder

http://api.juheapi.com/japi/beian

https://api.weixin.qq.com/cgi-bin/component/api_get_authorizer_list

https://api.weixin.qq.com/cgi-bin/clear_quota
       

  

     

 

  • 0
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
1. 模块命名、数据库表命名、域模型命名、各分层的类/方法命名、页面的命名; 模块命名: a. 包命名:com.project_name.module_name.action/service/dao/ws; service的实现都置于com.project_name.module_name.service.impl下; b. 接口命名遵守XxxxService,接口实现遵守XxxxServiceImpl; 2. 包的设计、页面的层次结构设计(jsp/css/js等文件的结构); 3. log、异常(声明式异常)的约定设计; 4. 链接、按钮、表单提交的统一方式;通用式Ajax调用与页面跳转统一模型; 5. 响应一个请求的分层结构约定,列举几个示例(常规调用、Ajax调用、WebService调用、提供WebService暴露、硬件设备接口调用); 6. 验证代码质量的约定,如JUnit、EMMA、FindBugs、CheckStyle、PMD的使用;Hudson持续集成需注意的; 7. 压力测试、防内存泄漏测试; 基础CSS:标签的各种状态的样式;表格单双行的样式; 开发一个Action请求的响应: 前置条件:该Action涉及的Entity及EntityName.hbm.xml已经准备好。 步骤: a. 前端页面触发Action的请求; 统一采用全路径请求,URL格式: 1> basePath/web/moduleName/*_ *.action {1}  EntityName,{2}  ActionMethodName 2> basePath/web/moduleName/gotoXxx.action (无需调用Service,直接跳转) 包括jQuery的Ajax方式和非Ajax方式; 包括表单提交; 参数设值的方式: 1> URL参数: basePath/web/moduleName/*_*.action?entity.propertyName=paramValue&paramName=paramValue 2> 或 另外,对于表单的提交,前后台都必须做数据校验,SWDF已提供了此能力,进行简单的配置即可,前台直接提供类似以下代码即可,点此查看前端校验详细规则说明。 前端校验示例; 后台数据校验,点此查看校验详细说明. b. 配置struts-moduleName.xml; 直接跳转示例; 调用Service示例; c. 开发对应的{EntityName}Action类; 该类必须继承com.hikvision.swdf.xx.BaseAction,该Action类有一个关键属性entity,即泛型Entity类的一个实体,该属性默认填充好了请求提交过来的entity对应参数(即entity.propertyName); d. 开发Service接口和Service接口实现,并在Action中通过set方法注入该Service; 接口文件:UserService 接口实现:UserServiceImpl 注入Service e. 开发DAO,DAO继承com.hikvision.xxx.HibernateBaseDAO; 示例 f. 配置applicationContext-*.xml; 配置DAO bean、Service Bean、Action Bean及注入的配置; g. 测试; 备注: 1. Action建议统一遵守通配符的约定,basePath/web/moduleName/*_ *.action {1}  EntityName,{2}  ActionMethodName 2. 统一命名规则:接口类似UserService,接口实现类型UserServiceImpl;(IUserService和UserServiceImpl) 开发一个Action调用关联应用提供的WebService 前置条件:该WebService?WSDL可正常获取 步骤: a. 配置applicationContext-wsclient.xml; Spring管理第三方WebService实例bean Jaxws-client配置代码 b. 生成第三方WebService接口文件;(提供系统自动生成) 自动生成代码 c. 页面调用Action请求,Action中注入WebService实例bean; Action对应方法直接调用第三方WebService的相关方法; d. 测试; 备注: 1. 步骤b,接口文件必须同包名同类名置于src目录下; 开发一个Action调用关联应用开放的HTTP请求 步骤: 1. 页面调用Action请求; 2. Action类相应方法使用封装好的HttpClient相关工具类,准备好HTTP请求的相关参数header参数和body参数并以xml的方式提交HTTP请求; 3. 解析该HTTP请求返回值(XML或JSON); 4. 响应结果; 5. 测试; 备注: 开发一个需要对第三方应用发布的WebService 步骤: a. 开发WebService接口,@WebService进行注解该接口; b. 开发WebService接口实现类,@WebService注解该实现类,并制定endpointInterface; c. 配置applicationContext-ws.xml d. 测试 备注: 开发一个需要对第三方应用发布的RESTful Service 步骤: a. 开发RS接口,提供如下Annotation; b. 开发RS接口实现,并提供如下Annotation; c. 配置applicationContext-rs.xml 备注: 所有Annotation的涵义解释如下:

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值