首页
学习
活动
专区
圈层
工具
发布
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    如何设计API返回码(错误码)?

    —1— 前言 客户端请求API,通常需要通过返回码来判断API返回的结果是否符合预期,以及该如何处理返回的内容等。...API返回码的设计还是要认真对待,毕竟好的返回码设计可以降低沟通成本以及程序的维护成本。...通过这样的设计,不论是程序还是人都可以非常方便的区分API的返回结果,关键是统一!...比方说20000-29999表示订单创建失败: 20001,订单创建失败,存在进行中的订单 20002,订单创建失败,上一个订单正在排队创建中 这两种错误情况如果是给用户看,可能就只适合看到:很抱歉,您有一个正在进行中的订单...但是对于API来说,返回的信息又必须是准确的,但用户看到的就必须转译,这个转译的工作调用方可以做,但是通常API提供者来提供个性化的Message能力会更好。

    1.1K10

    如何设计API返回码(错误码)?

    一、前言 客户端请求API,通常需要通过返回码来判断API返回的结果是否符合预期,以及该如何处理返回的内容等 相信很多同学都吃过返回码定义混乱的亏,有的API用返回码是int类型,有的是string类型...,不论是程序还是人都可以非常方便的区分API的返回结果,关键是统一!...您有一个正在进行中的订单,请到我的订单列表中处理。...或者API本机 application_id code message 100001 20001 很抱歉,您有一个正在进行中的订单,请到我的订单列表中处理。...100001 20002 很抱歉,您有一个正在进行中的订单,请到我的订单列表中处理。 然后在请求处理结束即将返回的时候,根据application_id+code,去匹配替换message ?

    7.3K30

    前后端分离--MockJS模拟API返回数据

    所以慢慢衍生出以重新的架构模式,在开发阶段前后端约定好Restful API的返回格式,然后后端业务逻辑设计Restful API,前端按照约定好的返回格式协同开发前端并独立完成测试工作。...而刚才也说到了前后端可以协同开发,那前端如果开发完成如何在API还没有完成的情况下机型模拟数据测试呢?所以本篇文章介绍一个前端开发利器---mockJS模拟Restful API 返回数据。...首先我们先创建一个api.js用于配置Mock的基本配置信息: import Mock from 'mockjs'; const url = { testUrl: 'http://api.niyueling.cn...,可以发现mock的使用很简单,但是这种集成在前端项目里面存在一个问题:如果后端Restful API实现完毕,前端需要将这部分调用mock的代码注释掉,不然真正的API调用会被mock拦截掉。...,但是多了一个优点在于后端Restful API还未实现,而前端需要测试,我们就可以使用npm run start命令你个启动这个Mock服务获取返回数据进行测试,当后端API实现完成,我们就停止这个Mock

    2.8K20

    使用Spring Boot开发一个属于自己的web Api接口返回JSON数据

    Web接口,返回JSON数据 ---- 我们在搭建好的Maven项目里面新建一个包,创建java文件 相关参数: @RestController 作用:用于标记这个类是一个控制器,返回JSON数据的时候使用...org.springframework.web.bind.annotation.RestController; import java.util.HashMap; import java.util.Map; //测试配置问文件 @RestController @RequestMapping("api...Spring Boot的默认端口访问为8080,当然这个也可也在相关的配置文件进行修改,访问测试可以使用浏览器输入localhost:8080/api/v1/test/testJson,在日常工作中,JSON...格式的数据也是后端跟前端交互使用最多的一种数据格式,也可也使用接口测试软件PostMan,测试结果如下,可以成功返回Json数据 ?...到这里,一个基于Spring Boot搭建的后端Web接口搭建完成。

    2.6K10

    Java API设计 - RESTful之统一返回格式

    RESTful 是目前最流行的 API 设计规范,用于 Web 数据接口的设计。它的大原则容易把握,但是细节不容易做对。本文总结 RESTful 的设计细节,介绍如何设计出易于理解和使用的 API。...场景 API 统一返回参数 对于实际开发很重要 可规范API接口格式 便于统一调取或做封装 对于第三方调用很友好 也是最重要的一点(不会被第三方调用者评论,你这API设计的真”辣鸡“,简直没法看!)...分析 继承与HashMap,所以返回统一返回参数本身也就是一个Map,并且实现 于Serializable可反序列化。...本身即是一个Map对象,可已Json格式推送给调用者,如果想到传参,直接put即可!...代码 package com.parker.api.common.result; import com.fasterxml.jackson.annotation.JsonIgnore; import

    1.9K40

    一个SpringMVC接口能返回JSON又能返回XML? 安排!

    我们有一个接口服务为下游的系统提供数据服务,本来好好的大家都愉快地传递JSON,非常和谐。可最近有个新需求去对接一个很老的系统,这倒是不算啥,可这个老系统数据不是以JSON传递的而是以XML传递的。...原理 在HTTP协议里,当客户端发起一个HTTP请求时,可以携带一个请求头Accept来告诉服务端,客户端可以接受哪些响应类型(MIME),可以是一个也可以是多个。...Spring MVC提供了一种被称作内容协商的机制,客户端在请求时声明需要的MIME类型,服务端只需要配置一些策略就是实现一个接口返回不同MIME类型的数据格式,想要JSON返回JSON,想要XML返回...根据上面的配置,如果你需要返回JSON: https://yourapi?...如果你需要返回XML: https://yourapi?

    84530

    一个SpringMVC接口能返回JSON又能返回XML? 安排!

    我们有一个接口服务为下游的系统提供数据服务,本来好好的大家都愉快地传递JSON,非常和谐。可最近有个新需求去对接一个很老的系统,这倒是不算啥,可这个老系统数据不是以JSON传递的而是以XML传递的。...原理 在HTTP协议里,当客户端发起一个HTTP请求时,可以携带一个请求头Accept来告诉服务端,客户端可以接受哪些响应类型(MIME),可以是一个也可以是多个。...Spring MVC提供了一种被称作内容协商的机制,客户端在请求时声明需要的MIME类型,服务端只需要配置一些策略就是实现一个接口返回不同MIME类型的数据格式,想要JSON返回JSON,想要XML返回...根据上面的配置,如果你需要返回JSON: https://yourapi?...如果你需要返回XML: https://yourapi?

    68030

    【5min+】美化API,包装AspNetCore的返回结果

    合理的定义API返回格式 先回到本文的主题,谈一谈数据返回格式。如果您使用的是WebAPI,那么该问题对您来说可能更为重要。...而后端开发者为了图方便,在api中随意返回结果,只负责业务能够调通就OK,但是却没有任何规范。 前端人员此时心里肯定有一万只草泥马在奔腾,心里默默吐槽: 这个老几写的啥子歪API哦!...因此,我们需要在API开发初期就协定一个完整的模型,在后期于前端的交互中,大家都遵守这个规范就可以避免这类问题。...我在这儿列了一个图,希望能给大家一个参考: ? 从图中我们就可以看出,我们通常在处理一个文件的时候,就不是返回ObjectResult了,而是返回FileResult。...AOP:直接对Action进行拦截,返回包装的结果。 该三种方式分别从 起始,中间,结束 三个时间段来进行操作。也许还有其它的骚操作,但是这里就不提及了。

    1.6K30

    Restful API实现乐观锁,应返回409还是412?

    近些年Restful API变得很流行,一个重要的原因是其充分利用HTTP协议标准,这样API Consumer消费Restful API的成本就小很多,API开发人员也更加有据可循。...这里讨论一个问题,对于Restful API的PUT操作,在并发环境下,两个Request更新同一条资源,可能会出现更新内容丢失的情况。针对这个问题,通常可以“加锁”来解决,那么加什么锁呢?...(select for update),在update语句执行完了才释放锁,这样两个PUT请求只能一个先执行一个后执行,就不会出现更新内容丢失的情况。...上面提到update执行失败,返回相应状态码提示用户请求执行失败,那么对于Restful API,应该返回什么状态码呢? 根据HTTP规范,有两个状态码可以使用:409和412。...从409的规范可以看出,当某一个资源的state发生了变化,导致request不能完成,可以返回409,提示用户解决冲突,重新提交请求。

    1.1K10

    这里有 Suno API 对接说明

    ,登录注册之后会自动返回当前页面。...基本使用 想些什么歌曲,可以任意输入一段文字,比如我想生成一个关于圣诞的歌曲,就可以输入 a song for Christmas,如图所示: 生成的代码如下: 可以点击「Try」按钮直接测试 API,...nThey twinkle and show\nFamilies gathering with love and cheer\nSpreading warmth to everyone near “注意,这里的歌词中...\n 是换行符,如果你不知道如何生成歌词,可以使用 AceDataCloud 提供的歌词生成 API 来通过 prompt 生成歌词,API 是 Suno Lyrics Generation API。...整体流程是:客户端发起请求的时候,额外指定一个 callback_url 字段,客户端发起 API 请求之后,API 会立马返回一个结果,包含一个 task_id 的字段信息,代表当前的任务 ID。

    74610
    领券