接口开发规范 restful接口开发规范

2024-04-12 02:27:02

2019独角兽企业重金招聘Python工程师标准>>>

1. Api请求及响应规范

为了严格按照接口进行开发，提高效率，对请求及响应格式进行规范化。

1、get 请求时，采用key/value格式请求，SpringMVC可采用基本类型的变量接收，也可以采用对象接收。
2、Post请求时，可以提交form表单数据（application/x-www-form-urlencoded）和Json数据（Content-Type=application/json），文件等多部件类型（multipart/form-data）三种数据格式，SpringMVC接收Json数据使用@RequestBody注解解析请求的json数据。
4、响应结果统一信息为：是否成功、操作代码、提示信息及自定义数据。
5、响应结果统一格式为json。

2. Api定义约束

Api定义使用SpringMVC来完成，由于此接口后期将作为微服务远程调用使用，在定义接口时有如下限制：

1、@PathVariable 统一指定参数名称，如：@PathVariable("id")
2、@RequestParam统一指定参数名称，如： @RequestParam（"id"）

转载于:https://my.oschina.net/edisonOnCall/blog/3036381

接口开发规范 restful接口开发规范相关推荐

前后端分离开发，RESTful 接口应该这样设计
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章译者 | 唐尤华 dzone.com/refcardz/rest- ...
EBay 接口开发（restful接口调用）
最近公司需要从eBay拉取数据,踩了很多坑,记录下过程. 首先,调用eBay接口需要注册eBay的开发者账号.注册地址:https://developer.ebay.com/signin.注册之后大概 ...
java测试restful接口_Postman 测试restful接口
日常开发中经常会遇到没有前提界面,直接调用后台restful接口的情景,不管时后台代码先行,并且开发完之后开发人员进行自测还是,或者是专业测试进行restful接口测试,都需要一款工具,现在就来介绍p ...
java调用restful接口_Java调用RESTful接口的几种方式
前端一般通过Ajax来调用,后端调用的方式还是挺多的,比如HttpURLConnection,HttpClient,Spring的RestTemplate 服务端代码如下: 服务端接口请求的URL:h ...
人人都是接口开发大师，这个开源项目花5分钟就可以开发一个API接口
PhalApi开源接口框架读音:派框架,官网:https://www.phalapi.net/ PhalApi是一个PHP轻量级开源接口框架,致力于快速开发接口服务.支持HTTP/SOAP/RPC等 ...
vue项目构建实战基础知识：SPA理解/RESTful接口介绍/static目录配置/axios封装/打包时map文件去除...
一.SPA 不是指水疗.是 single page web application 的缩写.中文翻译为单页应用程序或单页Web应用,更多解释请自行搜索. 所有的前端人员都应该明白我们的页面的 u ...
19年8月字母哥第二章 RESTFul接口实现与测试看到这里了
第二章 RESTFul接口实现与测试 2.1.RESTFul接口与http协议状态表述 2.2.常用注解开发一个RESTFul接口 2.2看完了 2.3 JSON数据处理与PostMan测试树哪 ...
简单识别 RESTful 接口
为什么80%的码农都做不了架构师?>>> 本文描述了识别一个接口是否真的是 RESTful 接口的基本方法.符合 REST 架构风格的接口,称为 RESTful 接口.本文不打 ...
【Node.js】关于Node.js接口的详解和案例--restful风格接口。案例：添加商品接口，添加员工接口，删除员工接口
1.首先我们需要知道,接口是什么? 接口是后端为前端提供的数据--动态资源:Node.js通过每一个路由就可以实现接口 2.RESTful接口:是一种接口的架构风格 1.请求的URL(资源) 在资源前 ...

最新文章

热门文章