• 阶段5 3.微服务项目【学成在线】_day01 搭建环境 CMS服务端开发_24-页面查询服务端开发-接口开发规范


    6.6.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。


    这个格式就是key/value的格式


    这里的查询条件是使用对象的形式来接收的





    响应的数据。
    success
    code
    message

    APi定义的约束

    6.6.2 Api定义约束


    Api定义使用SpringMVC来完成,由于此接口后期将作为微服务远程调用使用,在定义接口时有如下限制:
    1、@PathVariable 统一指定参数名称,如:@PathVariable("id") 2、@RequestParam统一指定参数名称,如:
    @RequestParam("id")



     

  • 相关阅读:
    一个漂亮的PHP验证码
    一个漂亮的php验证码类(分享)
    PHP中exit()与die()的区别
    自定义PHP页面跳转函数redirect($url, $time = 0, $msg = '')
    MySQL时间字段究竟使用INT还是DateTime
    mysql中为int设置长度究竟是什么意思
    Array数组对象
    Math对象
    对象篇学习-字符串对象
    事件的学习
  • 原文地址:https://www.cnblogs.com/wangjunwei/p/11543911.html
Copyright © 2020-2023  润新知