Django REST FRAMEWORK swagger框架详解

Posted 2020-11-10 zksfyz

Django REST FRAMEWORK swagger（一、框架详解）

一.Django REST  SWAGGER框架图

具体见下图

二.说明

• RESTFul说明

1. 每一个URI代表一种资源；

2. 客户端和服务器之间，传递这种资源的某种表现层；

3. 客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。

• Swagger说明

1. 大部分 Web 应用程序都支持 RESTful API，但不同于 SOAP API——REST API 依赖于 HTTP 方法，缺少与 Web 服务描述语言（Web Services Description Language，WSDL）类似的语言来定义使用者与提供者之间的请求和响应结构。由于没有充分的合同服务，许多 REST API 提供者使用 Microsoft Word 文档或维基页面来记录 API 用法。这些格式使协作和文档版本控制变得很困难，尤其对于有许多 API 或资源的应用程序，或者在 API 采用迭代式开发方式时。这些文档类型在集成到自动化测试应用程序中时变得更难。

2. 开源 Swagger 框架帮助 API 使用者和开发人员纠正了这些问题。该框架为创建 JSON 或 YAML（JSON 的一个人性化的超集）格式的 RESTful API 文档提供了 OpenAPI 规范（以前称为 Swagger 规范）。Swagger 文档可由各种编程语言处理，可在软件开发周期中签入源代码控制系统中，以便进行版本管理。

3. 实现 Swagger 扩展。

4. 简化 Swagger 的功能来聚合文档。

5. 创建一个输出 Swagger 文档为 html 页面的工具。