ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

openAPI与Restful API的区别

openAPI与Restful API的区别 RESTful API 关心“接口怎么设计”OpenAPI 关心“接口怎么描述”。它们可以一起使用。对比RESTful APIOpenAPI是什么遵循 REST 架构风格的 API描述 HTTP API 的标准规范关注什么资源、操作方式、无状态等设计原则路径、参数、请求体、响应、认证等表现形式实际接口的设计和行为JSON 或 YAML 格式的接口说明用途组织和提供服务生成文档、客户端代码支持测试REST 是一种架构风格OpenAPI 是机器和人都能读取的接口描述规范。REST 原始定义、OpenAPI 官方规范例如设计一个用户接口GET /users/123 获取用户 POST /users 创建用户 DELETE /users/123 删除用户这是常见的REST 风格设计路径表示资源HTTP 方法表示操作。而用 OpenAPI 描述它时会记录路径/users/{user_id} 方法GET 参数user_id整数必填 成功响应200返回用户信息 失败响应404用户不存在结合你现在的 FastAPI 项目/实际业务接口访问后返回{message: Hello World}。/openapi.jsonFastAPI 自动生成的 OpenAPI 接口说明。/docsSwagger UI 把这份说明展示成可交互的文档页面。FastAPI 文档有 OpenAPI 文档不代表接口就一定符合 RESTRESTful API 也可以没有 OpenAPI 文档。
返回列表