如何学习Django框架的基础模式与官方文档？

本文共计1901个文字，预计阅读时间需要8分钟。

模式与文档+目前我们已经完成了API，我们需要一种方法快速向其他人记录其功能。最终，在大多数公司和团队中，使用该API的开发人员与最初构建该API的开发人员不同。

模式和文档

现在我们已经完成了API，我们需要一种向其他人快速准确地记录其功能的方法。 毕竟，在大多数公司和团队中，使用该API的开发人员与最初构建该API的开发人员不同。 幸运的是，有自动化工具可以为我们解决这个问题。
模式是机器可读的文档，概述了它们支持的所有可用API端点，URL和HTTP谓词（GET，POST，PUT，DELETE等）。 文档是添加到架构中的东西，它使人类更易于阅读和使用。 在本章中，我们将向我们的Blog项目添加一个架构，然后添加两种不同的文档编制方法。 到最后，我们将实现一种自动化的方式来记录对API的当前和将来的任何更改。
提醒一下，这是我们当前API端点的完整列表：

模式

从​​3.9版​​生成架构的当前方法。

但是，由于这是一个迭代过渡，因此我们将在项目中使用传统的Core API方法自动生成API模式。 核心API与格式无关，这意味着它可以用于各种文档中。 基本上，您通常会首先使用Core API来生成模式，然后确定要在其中使用哪种文档格式。
我们还需要安装​​pyyaml​​，这将使我们以常用的基于YAML的OpenAPI格式呈现架构。

首先安装两个软件包。 确保本地服务器未运行Control + c。