如何写一个RestAPI 接口

最新推荐文章于 2024-06-23 13:56:24 发布
最新推荐文章于 2024-06-23 13:56:24 发布
阅读量2k 收藏
点赞数

我觉得写一个接口应该考虑如下的内容：

  1. 确定 url：是否符合 Restful，是否要符合公司确定的规范？是否简洁明确？
  2. 确认操作人的权限
  3. 确定要操作的资源的权限
  4. 验证传入的参数：不要相信外面传进来的任何数据
  5. 操作失败的提示
  6. 操作成功的提示
  7. 写文档：如何按规矩写好文档是一件值得花时间和精力梳理的事情
  8. 如何测试接口，用什么数据测试
转自：https://www.lijinma.com/blog/2015/12/17/thinking-when-creating-a-web-api/
benben_1678
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
【电商项目】-基于Rest编写API访问接口
知识改变命运，ヾ(◍°∇°◍)ﾉﾞ【求关注】
05-02 383
前言 本篇主要介绍我们对外API接口的编写，基于Rest风格进行编写 代码实现： controller层： package com.zcw.controller; import com.zcw.pojo.Stu; import com.zcw.service.StuService; import org.springframework.beans.factory.annotation.Au...
如何获取网站api接口_如何写好API接口文档
weixin_39951929的博客
12-15 4623
日常项目开发的过程中，接口文档是必不可少的。后端工程师与前端工程师之间需要接口文档来定义数据传输协议、系统对外暴露接口需要文档来说明、系统之间相互调用需要文档来记录接口协议等等。对于一个完整的项目，接口文档是至关重要的。那我们如何写好一份接口文档呢？今天就让我们说一说接口文档几个重要的要素。api1、接口概述接口概述主要说明本接口文档涉及到的业务功能点，面向的阅读对象以及接口文档主要包括...
REST设计风格之REST Api
weixin_44183759的博客
05-21 1034
一、概念 1.1 REST概念 REST（Representation State Transfer）:资源表述性状态转移，是一种结构风格。 ​ Resource：“资源”，网络上的一个实体，或者说网络上一个具体信息。它可以是一段文字、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URL（统一资源定位符）指向它，每种资源对应一个特定的URL。要获取这个资源，访问它的URL就可以，因此URL就成了每一个资源地址或独一无二的识别符。（一切皆资源，URL用于资源的唯一标识）。 ​ Re
什么是Rest风格的Api？
qq2212573001的博客
09-02 3502
在聊这个问题之前，先来说一说什么是Api： API（Application Programming Interface，应用程序接口）是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。 [1] 目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问原码，或理解内部工作机制的细节。 上面的是百度百科对于Api的解释，那么通俗的讲什么是API呢？ APi就是开发...
什么是REST API
最新发布
朱豪凯的博客
06-23 650
REST API 易于理解和实现，支持跨平台和跨语言通信，灵活、扩展性强，使用标准HTTP协议，简化数据交换。支持多种数据格式，易于缓存和分层架构，提升了应用的开发效率和性能。
编写REST API
格物致知的专栏 [音视频编解码 网络协议 计算机视觉 计算机图形学 图像理解 语音识别 机器学习 模拟电路 传感器]
05-28 165
REST API规范 编写REST API，实际上就是编写处理HTTP请求的async函数，不过，REST请求和普通的HTTP请求有几个特殊的地方： REST请求仍然是标准的HTTP请求，但是，除了GET请求外，POST、PUT等请求的body是JSON数据格式，请求的Content-Type为application/json； REST响应返回的结果是JSON数据格式，因此，响应的Content-Type也是application/json。 REST规范定义了资源的通用访问格式，虽然它不是一个强制
RESTful API接口规范及使用
lidasha_521的博客
04-10 4579
RESTful API接口规范及使用
rest api 接口测试工具
03-01
Advanced REST Client是Google Chrome浏览器的一个扩展，它是一个强大的REST API测试工具。版本v3.1.9提供了以下功能： 1. 支持所有HTTP方法：包括基本的GET、POST、PUT、DELETE以及HEAD、OPTIONS、PATCH等。 2. ...
H3C CAS REST API接口
08-26
H3C CAS REST API接口提供了多种功能，例如： 1. 虚拟机管理：创建、查询、启动、停止、重启和销毁虚拟机。 2. 网络资源管理：创建、修改和删除网络，包括VLAN、子网、端口组等。 3. 存储资源管理：分配、释放存储...
REST API接口测试学习.emmx
01-09
REST API接口测试学习.emmx
晓想REST API ：小晓想开发的一个REST API
03-29
为小晓想开发的一个REST API 用于小程序接口试调，开发。 REST API 资源汇总 https://tinyapp.sparklog.com/ // => apis 返回当前所有资源接口 微信登录 GET: `https://tinyapp.sparklog.com/session/?code=${code...
restful接口实现Demo
12-04
result接口实现的Demo，下载解压放入到tomcat中启动，然后运行里面的client方法，帮助了解restful编写
Django+RestFramework API接口及接口文档并返回json数据操作
09-16
在本文中，我们将深入探讨如何使用Django框架与Django Rest Framework（DRF）来创建API接口，并生成接口文档以及返回JSON数据。首先，我们来看看Django和DRF是什么。 Django是一个用Python编写的高级Web框架，它...
基于Rest风格编写API接口
老婆就是要败家
10-31 742
1. 名词解释 Restful 风格就是一种编写规范 , 可以让人看起来接口名称 , 就能猜出是在做什么 ! 基本上就是你要操作的表名称(小写)+Service(大写) 这就是一个接口 2. 例子引导 例如 ; 编写一个service接口 public interface StuService { /*查询用户*/ public Stu findStu(int id); /*增加用户*/ public void saveStu(); /*删除stu*/ pu
Restful API 接口规范
LMGD的博客
04-23 2万+
Restful API 介绍 1）REST：英文representational state transfer直译为表现层状态转移，或者表述性状态转移；Rest 是web服务的一种架构风格，一种设计风格，是一种思想；同时Rest不是针对某一种编程语言的。 2）Restful(又名Rest):用URL定位资源、用HTTP动词（GET、POST、PUT、DELETE)描述操作、用HTTP STATUS/CODE定义操作结果。 以webService为例通俗解释 非Rest设计，以往我们都会..
Restful API思路
alashan007的博客
11-08 1371
1.通过服务器重写规则，将所有请求走一个入口方法，例如index.php的run()方法。 2.通过$_SERVER,找到请求方法，请求路径，请求参数，进行初始化参数 3.根据请求路径，走不同model处理，根据请求方法不同，走不同的处理方法。 4.补充，可以封装错误和异常处理，提前定义好允许的请求方法，等等。 以下为补充材料 https://blog.csdn.net/lmseo...
REST API 的最佳入门教程
weixin_30580943的博客
12-15 6995
如果你看到这里，你以前可能听说过API 和REST,然后你就会想:“这些都是什么东西？”。也许你已经了解过一些这方面的知识，但却不知道从何入手。在这个教程中，我将会诠释REST的基础以及如何给应用创建一个API（包括认证授权） 什么是API? API是Application Programming Interface（应用程序界面）的缩写，它是拿来描述一个类库的特征或是如何去运用它。你个...
rest api的编写
jmhIcoding
10-21 1152
0.What is rest ： REST（英文：Representational State Transfer，又称具象状态传输）是Roy Thomas Fielding博士于2000年在他的博士论文[1] 中提出来的一种万维网软件架构风格，目的是便于不同软件/程序在网络（例如互联网）中互相传递信息。 目前在三种主流的Web服务实现方案中，因为REST模式与复杂的SOAP和XML-R
理解并设计rest/restful风格接口
热门推荐
马万明的专栏
08-31 6万+
网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备......）。 因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我以前写过一篇《理解RESTful架构》，探讨如何理解这个概
springboot怎么写rest api接口
05-10
Spring Boot是一个用于快速开发Spring应用程序的框架，其中包含了很多的自动化配置，它建立在Spring之上，使得开发人员能够更快、更轻松地开发出高品质的应用程序。Spring Boot通过提供默认配置和快速应用程序启动来...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值