接口的设计原则在设计接口时，有很多因素要考虑，如：接口的业务定位，接口的安全性，接口的可扩展性、接口的稳定性、接口的跨域性、接口的协议规则、接口的路径规则、接口单一原则、接口过滤和接口组合等；规范性建议1.职责原则在设计接口时，必须明确接口的职责，即接口类型，接口应解决什么业务问题等2.单一性原则在明确接口职责的条件下，尽量做到接口单一，即一个接口只做一件事，而非两件以上。3.协议规范在设计接口时
RESTful本身是一种风格而不是规范，本文为该风格的规范实现的最佳实践，本文档详细说明了HTTP RESTful API的定义和使用规范，作为接口调用者和实现者的重要参考。接口风格遵循RESTful设计风格，同时控制复杂度及易于使用，仅遵循大部分原则。 遵循原则：使用https协议版本号放入URL或Header只提供json返回格式post,put上使用json作为输入使用http状态码作为错误
转载
2024-05-24 10:00:31
44阅读
在设计接口时，有很多因素要考虑：接口的业务定位接口的安全性接口的可扩展性接口的稳定性接口的跨域性接口的协议规则接口的路径规则接口单一原则接口过滤及接口组合本篇文章将简要分析这些因素。 一 规范性建议1.职责原则在设计接口时，必须明确接口的职责，即接口类型，接口应解决什么业务问题等2.单一性原则在明确接口职责的条件下，尽量做到接口单一，即一个接口只做一件事，而非两件以上。很多非资深接口设计
转载
2024-03-01 11:26:02
48阅读
在需求文档完成后，测试人员以及开发人员应该分别开始了自己的工作。测试人员开始按照需求文档编写修改Case，并制定合适的测试计划，评估自动化测试的可行性等。开发人员根据职位的不同开展各自的工作。作为普通程序员：一.掌握核心业务流程：在前期项目中 编写需求文档 这段时间中，应该对项目有一个基本的了解，并对项目的核心业务有一个明确的认识。往往我对核心业务掌握的不够全面，导致后期代码编写过程中，会出现一些
通用要求接口命名小驼峰 如果不是restfull的接口，需要语义化，例如：getUserInfo、getUserList、createUser、updateUser、deleteUser、uploadUserImg 接口尽量轻巧，前端不需要的数据，不需要返回 后端尽量统一风格，禁止单独适配为了避免某些Chrome浏览器广告屏蔽插件的误拦截，不使用ad等广告字眼对前端的要求：前端使用axios统一封
转载
2024-01-03 15:44:26
148阅读
关于REST
前后端接口按照粗浅的REST规则制定，其主要表现为：
使用GET、POST、PUT、DELETE共4个HTTP Method，而非简单的GET和POST两者。
响应使用HTTP状态码来标志请求的执行结果，而非以往的success字段。
URL符合业界普遍接受的REST规则，减少在URL中标识操作类型的情况，如使用POST /users代替POST /use
转载
2024-06-07 15:33:33
119阅读
大家好，我是二营长，日拱一卒无有尽,功不唐捐终入海。这里是Java学习小站，关注我，每天进步一点点！接口的重要性：在日常的开发中，在需求确定之后，后端同学首先要做的就是定义接口，接口定义完成之后，前端的同学就可以看接口文档和后端进行同步开发了。接口文档的作用还有很多：
沟通：开发、测试和其他人员之间的沟通渠道；它定义了接口的规范和预期行为，确保所有团队成员对接口的功能和使用方式有共同的理
转载
2024-07-29 14:20:40
45阅读
前后端接口规范 来源： https://github.com/f2e-journey/treasure/blob/master/api.md
随着前后端分离越来越普遍, 后端接口规范也就越来越重要了. 一套良好的接口规范可以提升工作效率, 减少沟通障碍.通常我们都会采用 REST 方式来提供接口, 使用 JSON 来传输数据.名词含义前端Web前端, AP
转载
2023-12-28 21:53:31
72阅读
华为Java一面· 1H闲聊偏多，问的技术性问题比较基础·简单说说面向对象的特征以及六大原则·谈谈final、finally、finalize的区别·Java中==、equals与hashCode的区别和联系·谈谈Java容器ArrayList、LinkedList、·HashMap、HashSet的理解，以及应用场景·谈谈线程的基本状态，其中的wait() sleep() yield()方法的区
---
title: Java后端接口设计规范
---
## 概述
本文旨在教会刚入行的小白如何实现Java后端接口设计规范。首先，我们将介绍整个流程的步骤，然后详细说明每一步需要做什么，并提供相应的代码示例。
## 流程图
```mermaid
flowchart TD
A[定义接口] --> B[实现接口]
B --> C[添加请求参数]
C --> D[处理请
原创
2023-08-27 04:35:39
109阅读
一、接口1、接口是什么？接口也是一种规范：约束别人必须这样设计。规范一定是公开的：比如学校规定每天早上8点上课，是不是要公开出去？所以接口里面设计的常量和抽象方法必须都是公开化的，如果你不用public修饰，它也会默认为public，写不写都是公开的；举个例子：比如生活中的插座，规定是两孔就是两孔，你拿个三孔来插入两孔的，是不是就插不进？2、接口的定义与特点语法格式：接口用 interface 关
转载
2024-02-21 10:22:03
83阅读
单一职责一个类只负责完成一个职责或者功能。不要设计大而全的类，要设计粒度小、功能单一的类。单一职责原则是为了实现代码高内聚、低耦合，提高代码的复用性、可读性、可维护性。不同的应用场景、不同阶段的需求背景、不同的业务层面，对同一个类的职责是否单一，可能会有不同的判定结果。实际上，一些侧面的判断指标更具有指导意义和可执行性，比如，出现下面这些情况就有可能说明这类的设计不满足单一职责原则：类中的代码行数
转载
2023-09-20 13:18:34
61阅读
一、HTTP请求HTTP即超文本传输协议，用以进行HTML 文件、 图片文件、 查询结果等的网络传输。一个完整的HTTP请求包括：请求行、请求头、空行和请求数据(请求数据可以为空)HTTP1.1标准请求方式有：GET, POST, PUT, HEAD, DELETE, CONNECT, TRACE, OPTIONS请求行和请求头里包含URL、Request Method、Accept、Cookie
转载
2024-05-11 12:06:17
74阅读
springboot/web项目优秀的后端接口体系，看一篇就够了项目构建-统一参数校验，统一结果响应，统一异常处理，统一错误处理，统一日志记录,统一生成api文档1. 前言一个后端接口大致分为四个部分组成：接口地址（url）、接口请求方式（get、post等）、请求数据（request）、响应数据（response）。 本文主要演示如何构建起一个优秀的后端接口体系，体系构建好了自然就有了规范，同时
转载
2024-03-14 16:29:25
543阅读
前言前段时间，我向一位在阿里的朋友寻求进大厂的秘诀，他分享给我一份阿里内部资料——JAVA核心进阶手册，仔细翻阅一番才知道里面收纳整理的知识可真是齐全，不得不来感叹一番…我将JAVA核心进阶手册大致分为以下5篇内容基础：多线程+网络+数据结构与算法+MySQL+Tomcat框架：设计模式+Spring+SpringMVC+MyBatis分布式架构：限流（ZK/Nginx）+缓存（Redis/Mon
虽然现在慢慢在流行前后端分离开发，但是还是有一些公司在做前后端不分的开发，而在前后端不分的开发中，我们就会需要后端页面模板（实际上，即使前后端分离，也会在一些场景下需要使用页面模板，例如邮件发送模板）。后端页面模板比如： JSP，Velocity，FreeMaker等。 早期的 Spring Boot 中还支持使用 Velocity 作为页面模板，现在的 Spring Boot 中已经不支持 Ve
转载
2024-01-15 09:24:18
60阅读
命名风格类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：DO/BO/DTO/VO/AO正例：MarcoPolo/UserDO/XmlService/TcpUdpDeal/TaPromotion反例：marcoPolo/userDo/XMLService/TCPUDPDeal/TAPromotion方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风
转载
2024-02-02 08:40:37
93阅读
实际上就是用RESTful风格来包装HTTP协议，并用json或xml格式实现数据交互。RESTful风格: 网络资源实体化，CURD对资源进行操作。好的规范评判标准：直观、扩展、优雅1.数据交互格式推荐json, 紧凑、易于读写、占用带宽小、各种编程语言支持。以下均已json格式为例。 HTTP 请求头:## 客户端接受数据类型，服务端根据Accept字段调整返回消息的数据格式
Accept:a
转载
2024-05-08 19:13:53
91阅读
背景一线城市很多公司都实现了前后端分离的开发模式。除去所谓的Restful接口设计模式，如何来设计接口呢？基本信息：项目有中文版和英文版，也有稳定区和创新区，这里的稳定区和创新区只是一个业务逻辑上的一个概念。需求：我们需要查询项目，而条件是中文还是英文，稳定区还是创新区。这里主要分析是通过接口类别来隔离业务逻辑，还是通过一个接口的参数不同来区分业务类别呢？过程思路一：后台接口设计，采用完全隔离的方
转载
2024-07-02 21:33:38
55阅读
RESTful 接口规范 OneCoder最近一直在使用Restful API，最近正好看到一篇自定义restful接口规范的“抛砖引玉”得的文章，索性翻译一下，与大家分享。
最近，我正在使用RESTfull的方式构建一个web服务。尽管现在有很多的一般的指导和提示告诉你如何定义restful接口，但是却没有一个明确的标准或大家都接受的schema定义去遵循。
转载
2024-05-24 15:36:53
32阅读
