Django开发API是否默认符合OpenAPI3.0规范？如何验证合规性？

1. Django开发的API默认是否符合OpenAPI规范？ #

完全不符合。
你看到的“Django Automates generation of OpenAPI 3”表述，指向的是Django第三方生态的扩展能力，并非Django核心框架的自带功能。原生Django没有内置任何OpenAPI相关能力，编写的API默认不会输出任何符合OpenAPI格式的接口描述文件，完全不存在开箱即合规的情况。
即便是绝大多数Django API开发会用到的Django REST Framework（DRF），本身默认也只提供基础API开发能力，不会自动生成符合OpenAPI 3.0规范的接口描述。

2. 是否需要额外配置/改造才能满足OpenAPI 3.0合规要求？ #

需要，不存在零配置直接合规的情况，核心要做的工作包括：

• 选配合规的schema生成组件：基于DRF开发时优先选择对OpenAPI 3.0全特性支持的生成库，不要用老旧的、仅兼容Swagger 2.0的旧组件，这类组件对OpenAPI 3.0的多状态码、内容协商、组件复用等特性支持残缺，很容易出现合规问题
• 补全接口元信息：自动生成逻辑只能通过代码结构推断最基础的字段信息，你需要手动为接口、序列化器、参数、响应模型补全明确的描述、类型约束、必填规则、状态码定义、鉴权规则等元信息，不能完全依赖工具自动推断
• 补全特殊场景的schema描述：对于自定义响应格式、文件上传下载、批量操作、非标准异常返回等非通用逻辑，要通过组件提供的扩展装饰器手动补充描述，避免生成的文档和实际接口逻辑不一致
• 填齐OpenAPI根节点必填字段：补充API标题、版本号、服务描述、全局鉴权方案等OpenAPI 3.0规范要求的根节点必填信息

3. OpenAPI 3.0合规性的测试验证方式 #

可以通过多层校验确保真正合规，不要只做表面格式检查：

• 基础格式校验：把生成的openapi.json/openapi.yaml描述文件通过OpenAPI官方结构校验工具检查，确认所有字段符合3.0版本的结构规范，没有语法错误、必填字段缺失、字段类型不合法的问题
• 接口一致性校验：通过校验工具对比实际运行的API行为和schema描述的匹配度，排查实际请求参数、响应字段、状态码、错误返回和文档描述不匹配的问题——这是合规校验的核心，自动生成的schema很容易出现“文档和实际接口两张皮”的问题
• 生态兼容性验证：把生成的schema导入常见的OpenAPI兼容工具（接口调试工具、文档渲染工具等），确认所有接口可以被正常识别、解析、发起调试，没有字段丢失、参数识别错误的问题
• 强合规场景可以把schema校验、一致性校验步骤加入CI/CD流程，每次代码更新自动跑校验规则，避免迭代过程中出现schema和接口脱节、不符合规范的问题

注意：仅通过schema格式校验不代表真正合规，格式正确但和实际API行为不一致的OpenAPI描述，完全不满足合规要求。

内容的提问来源于stack exchange，提问作者Blue Clouds