rest 是一种软件架构风格，如果你们的接口是 rest 接口，那么就可被认为你们的的接口是restful的，英文名词和形容词的区别。rest 接口是围绕“资源”展开的，利用HTTP的协议，其实rest本也可以和HTTP无关，但是现在大家普遍的使用 rest 都是依托于HTTP协议。HTTP 的url即资源。Restful API 设计规范一、协议API与用户的通信协议，总是使用HTTPs协议。二
转载
2024-03-02 09:28:10
275阅读
RESTful API 统一约束客户端和服务器之间的接口。简化和分离系统架构，使每个模块独立！ RESTREST即表述性状态传递（英文：Representational State Transfer，简称REST）是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格。它是一种针对网络应用的设计和开发方式，可以降低开发的复杂性，提高系统的可伸缩性。**REST是设计风格而
转载
2024-03-12 16:38:22
481阅读
前言越来越多的Web应用程序使用JSON作为API的一种数据交换格式进行交互。本文档的目标是使HTTP JSON API的设计风格保持一致，容易被理解和维护。一个优秀的API，应该是在其生命周期内能够持续提供稳定、易用、受信任的服务，并且在API的生命周期结束时能让其平滑的消亡。注：RESTful API是目前比较成熟的一套Web应用程序的API设计理论，本文不对RESTful API过多介绍。在
转载
2023-07-06 18:49:56
387阅读
接口设计及文档管理系列 各个工具及概念介绍OpenAPIOpenAPI规范OpenAPI规范的历史OpenAPI描述文档格式OpenAPI 2.0描述文档OpenAPI 3.0描述文档SwaggerSwagger UISwagger EditorSwagger CodegenSwagger HubSwagger InspectorSpringfox Swagger 根据代码（注解）生成接口文档S
转载
2024-02-28 13:13:23
215阅读
restful apirest 全拼是resource representational state transfer，资源表现层状态转移，在网络中的进行交互的数据都是一个个资源，rest便是对这其中数据状态转移过程的规范，是一种web应用接口的规范。rest规范每一个URI都是一个资源，因为我们在请求一个接口的时候，其实就是访问服务器对应URI地址下的资源，所以说每一个URI都是一个资源。同一种
转载
2024-05-22 10:51:39
48阅读
RESTful API 接口规范文档是指基于REST原则设计的API接口文档，它定义了API的设计规范、请求方式、响应格式等内容，使得API开发更加规范、易于理解和使用。下面我将向你详细介绍如何实现RESTful API接口规范文档。
### 实现步骤
首先，我们需要了解整个实现RESTful API接口规范文档的流程，具体步骤如下：
| 步骤 | 操作 |
| :---: | :--- |
原创
2024-05-06 11:30:49
312阅读
GitLab 中文文档 使用 .gitlab-ci.yml 配置project's builds.gitlab-ci.yml的用法，这个文件被 GitLab Runner用来控制project's builds流程。 如果你想快速了解 GitLab CI的介绍，可以阅读 GitLab CI快速入门.Table of Contents generated with Do
转载
2024-03-29 13:04:50
480阅读
Java 支持 3 种注释，分别是单行注释、多行注释和文档注释。文档注释以/**开头，并以*/结束，可以通过 Javadoc 生成 API 帮助文档，Java 帮助文档主要用来说明类、成员变量和方法的功能。文档注释只放在类、接口、成员变量、方法之前，因为 Javadoc 只处理这些地方的文档注释，而忽略其它地方的文档注释。Javadoc 是 Sun 公司提供的一种工具，它可以从程序源代码
转载
2023-08-25 20:04:10
290阅读
JavaEE的JSON API规范JSON-P/JSON-B
原创
2022-10-28 13:22:39
25阅读
1 API接口规范REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。 它首次出现在2000年Roy Fielding的博士论文中。RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访
转载
2023-09-15 15:35:41
54阅读
实际上就是用RESTful风格来包装HTTP协议，并用json或xml格式实现数据交互。RESTful风格: 网络资源实体化，CURD对资源进行操作。好的规范评判标准：直观、扩展、优雅1.数据交互格式推荐json, 紧凑、易于读写、占用带宽小、各种编程语言支持。以下均已json格式为例。 HTTP 请求头:## 客户端接受数据类型，服务端根据Accept字段调整返回消息的数据格式
Accept:a
转载
2024-05-08 19:13:53
91阅读
本规范的三个目标：简洁、统一、开放。关于如何设计良好风格的 RESTful API，Github 有一份满分答案，熟读三遍，其义自现。本规范将在其基础之上使用尽可能简单的表述方式从以下几个常见部分作出详细约定：基础约定创建类接口查询类接口文件类接口敏感类接口图表类接口
注意本规范是笔者在所在公司内部制定的规范整理而来的接口规范模板，仅供你在制定规范时候参考，在落地时应根据团队实际情况作出调整，
4、面向资源编程： 路径，视网络上任何东西都是资源，均使用名词表示（可复数）
转载
2023-07-31 20:48:16
122阅读
OpenAPI规范
原创
2021-09-14 15:44:20
606阅读
https://weui.io weui.css .weui-cell_select-before .weui-cell__bd:after{ display:none; } .weui-cell_select-after{ padding-left:15px; } .weui-cell_selec
转载
2018-10-02 15:04:00
157阅读
2评论
RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。它的大原则容易把握，但是细节不容易做对。本文总结 RESTful 的设计细节，介绍如何设计出易于理解和使用的 API。一、URL 设计1.1 动词 + 宾语RESTful 的核心思想就是，客户端发出的数据操作指令都是"动词 + 宾语"的结构。比如，GET /articles这个命令，GET是动词，/artic
转载
2024-05-22 10:49:36
884阅读
Swagger（丝袜哥）是一个简单但功能强大的API表达工具。它具有地球上最大的API工具生态系统，数以千计的开发人员，使用几乎所有的现代编程语言，都在支持和使用Swagger。使用Swagger生成API，我们可以得到交互式文档，自动生成代码的SDK以及API的发现特性等。前后端分离的项目，接口文档的存在十分重要。与手动编写接口文档不同
原创
2021-09-26 09:54:29
10000+阅读
在前端与后端分离开发的场景下、在外部需要提供的接口场景下，以及其他需要进行业务数据对接交互的场景下时，需要提供明确的接口功能说明及相关参数说明，此文档在分离开发下时，是必不可少的，现在通过编写.Mackdown
原创
2017-10-13 15:04:13
9595阅读
rest 是一种软件架构风格，如果你们的接口是 rest 接口，那么就可被认为你们的的接口是restful的，英文名词和形容词的区别。 rest 接口是围绕“资源”展开的，利用HTTP的协议，其实rest本也可以和HTTP无关，但是现在大家普遍的使用 rest 都是依托于HTTP协议。HTTP 的u
原创
2022-01-16 14:26:19
364阅读
RESTFul规范RESTFul是一种HTTP API接口规范，只要满足的RESTFul规范，即可称为RESTFul API。既然是接口，我们先来了解一下，他和传统的API接口有何不同吧。本文以尽量简单明了的文字来介绍、描述，只讲核心内容，仅供入门指引。1 与传统API的区别RESTFul世界中，一切皆抽象为资源(Resource)。用户是资源，文章是资源、评论是资源，抽象一点的session、t
转载
2024-05-22 12:04:25
96阅读
