配置OpenAPI架构

OpenAPI 是什么?

Open API 即开放 API，也称开放平台。 所谓的开放 API（OpenAPI）是服务型网站常见的一种应用，网站的服务商将自己的网站服务封装成一系列
API（Application Programming Interface，应用编程接口）开放出去，供第三方开发者使用，这种行为就叫做开放网站的 API，所开放的 API 就被称作 OpenAPI（开放 API ）。

RESTful API 是什么?

什么是 REST？
Representational State Transfer，翻译是”表现层状态转化”。可以总结为一句话：REST 是所有 Web 应用都应该遵守的架构设计指导原则。
面向资源是 REST 最明显的特征，对于同一个资源的一组不同的操作。资源是服务器上一个可命名的抽象概念，资源是以名词为核心来组织的，首先关注的是名词。REST 要求，必须通过统一的接口来对资源执行各种操作。对于每个资源只能执行一组有限的操作。

什么是 RESTful API？

符合 REST 设计标准的 API，即 RESTful API。REST 架构设计，遵循的各项标准和准则，就是 HTTP 协议的表现，换句话说，HTTP 协议就是属于 REST 架构的设计模式。比如，无状态，请求-响应。。。

官方文档参考： Django REST框架3.10

继续使用CoreAPI

如果当前使用的是CoreAPI模式，则需要确保更新REST框架设置以 DEFAULT_SCHEMA_CLASS明确包含。

在setting中配置REST框架：

settings.py：

REST_FRAMEWORK = {
  ...
  'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema'
}

image.png

设置主url：

urlpatterns = [
#...
 path('docs/',include_docs_urls(title="oyzx的api")),
#...
]

访问http://127.0.0.1:8000/docs/](http://127.0.0.1:8000/docs/:

image.png

==============================================================

增加备注信息

在字段后面增加required=True,help_text='xxxx'

#...
id = serializers.IntegerField(required=True,help_text='用户主键')
#...

image.png image.png

第二种 继承ModelViewSet类

光标放在ModelViewSet地方可发现此类有create(),retrieve(),update(),partial_update(),destroy()和list()方法

可选择部分方法进行备注：

  """
        list:
            磁盘列表
        retrieve:
            磁盘详细信息
    """

list( )方法 列表信息：

image.png

retrieve( ) 列表详细信息：

image.png