如何创建接口,设计过接口

简介: 项目遵循Restful规范设计接口,请求路径基于资源命名,如查询用GET,新增用POST,修改用PUT,删除用DELETE。GET参数通过问号或路径传递,POST/PUT用JSON。统一的接口规范规定:返回数据多时,用VO过滤或整合数据。

首先需求确定之后,我们会根据产品原型和需求文档来设计接口,我们项目中是遵循了Restful风格的规范。主要包含了几个部分

  • 请求路径:一般都是以资源名称或者小模块名称进行命名
  • 请求方式
    • 查询是get请求
    • 新增是post请求
    • 修改是put请求
    • 删除是delete请求
  • 接口的入参,一般也有两种形式
    • 其中get请求会使用问号传参或者是path路径传参,后端使用形参接收参数
    • 如果是put或者post请求会使用json对象传参,后端需要使用dto去接收参数
  • 接口的出参,我们项目中定义了统一的接口规范
    • 如果返回数据较多,一般会封装一个vo进行返回,vo可以过滤敏感数据,或者是整合数据
目录
相关文章
|
9月前
|
监控 应用服务中间件 API
API 网关的功能用途及实现方式
API 网关的功能用途及实现方式
|
缓存 JavaScript API
深入解析API调用:构建现代应用的数据连接纽带
在今天的应用开发中,API调用是构建现代应用的关键组成部分之一。通过API调用,应用程序可以与外部服务通信,获取数据、发送请求并实现各种功能。本博客将深入研究API调用的核心概念、最佳实践以及如何在应用程序中创建强大的数据连接。
294 0
|
7月前
|
Java
设计接口的几种方法
设计接口的几种方法
|
9月前
|
安全 前端开发 NoSQL
如果让你设计一个接口,你会考虑哪些问题?
接口设计需关注参数校验、扩展性、幂等性、日志、线程池隔离、异常重试、异步处理、查询优化、限流、安全性、锁粒度和避免长事务。入参与返回值校验确保数据正确性;考虑接口扩展性以适应不同业务需求;幂等设计防止重复操作;关键接口打印日志辅助问题排查;核心接口使用线程池隔离确保稳定性;异常处理中可采用重试机制,注意超时控制;适合异步的场景如用户注册后的通知;并行查询提升性能;限流保护接口,防止过载;配置黑白名单保障安全;适当控制锁粒度提高并发性能;避免长事务影响系统响应。
146 2
|
9月前
|
消息中间件 设计模式 监控
如何优雅地实现接口统一调用?
【2月更文挑战第6天】
500 3
|
数据挖掘 API PHP
Playfab开发(一)如何调用PlayFab接口
Playfab开发(一)如何调用PlayFab接口
接口的基本概念
接口的基本概念
71 0
|
C#
C# 接口案例
C# 接口案例
120 4