2025年使用swagger 生成 Flask RESTful API

使用swagger 生成 Flask RESTful API什么是 REST REST 英文 Representati State Transfer 又称具象状态传输 是 Roy Thomas Fielding 博士于 2000 年在他的博士论文 中提出来的一种万维网软件架构风格 目的是便于不同软件 程序在网络 例如互联网 中互相传递信息

大家好,我是讯享网,很高兴认识大家。

什么是REST

REST(英文:Representational State Transfer,又称具象状态传输)是Roy Thomas Fielding博士于2000年在他的博士论文 中提出来的一种万维网软件架构风格,目的是便于不同软件/程序在网络(例如互联网)中互相传递信息。

REST 的核心是可编辑的资源及其集合,用符合 Atom 文档标准的 Feed 和 Entry 表示。每个资源或者集合有一个惟一的 URI。系统以资源为中心,构建并提供一系列的 Web 服务。

在 REST 中,开发人员显式地使用 HTTP 方法,对系统资源进行创建、读取、更新和删除的操作:

  • 使用 POST 方法在服务器上创建资源
  • 使用 GET 方法从服务器检索某个资源或者资源集合
  • 使用 PUT 方法对服务器的现有资源进行更新
  • 使用 DELETE 方法删除服务器的某个资源

如果一个架构符合REST原则,就可以称它为RESTful架构


讯享网

RESTful API 设计定义

以下是几个RESTful API的几个概念。

  • 资源(Resource):系统上的所有事物都被抽象为资源(一篇文章,一张照片,一段语音)
  • 集合(Collection):一组资源的合辑称为集合(几篇文章,几张照片)
  • 路径(Endpoint):路径又称”终点“,表示API的具体网址(每个网址代表一种资源)

那么一个设计良好的RESTful API应该遵循哪些原则呢?

协议

API与用户的通信协议总是使用HTTPs协议。

域名

应该尽量将API部署在专用域名,例如:

小讯
上一篇 2025-01-17 11:36
下一篇 2025-03-14 07:31

相关推荐

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请联系我们,一经查实,本站将立刻删除。
如需转载请保留出处:https://51itzy.com/kjqy/116197.html