当前位置:   article > 正文

大模型中Add actions的Schema_哪些大模型支持 actions

哪些大模型支持 actions

什么是schema

        在计算机科学和软件工程中,"schema"一词通常指的是一个数据结构的组织或布局。它用于描述数据库、XML文件、JSON对象等的结构和规则。

        schema有不同的含义:

  1. 数据库schema: 这是数据库中数据的结构描述,包括表、视图、索引、关系等。它定义了数据如何存储在数据库中,以及数据之间的关系。

  2. XML schema: 这是一个定义XML文档结构的标准,用于验证XML文档的内容是否符合预定义的结构和数据类型。

  3. JSON schema: 类似于XML schema,JSON schema定义了JSON数据的结构,可以用来验证JSON数据。

        Add actions的Schema,"schema"是指OpenAPI规范的主体,它定义了API的结构和行为。这包括端点的路径、支持的操作、预期的请求和响应格式等。简而言之,OpenAPI schema为如何使用API提供了详细的指南和规则。

  • Authentication: 设置API是否需要认证,以及认证的类型。在截图中显示为“None”,意味着API目前不需要认证。

  • Schema: 是API规范的主体,定义了API的结构,包括:

    • openapi: 规范的版本。
    • info: 提供API文档的基本信息,如标题、描述和版本。
    • servers: 列出API服务器的URL,用于API的基础路径。
    • paths: 定义API端点和HTTP方法。
    • components: 用于定义可重复使用的组件,如请求体、响应体、参数和安全方案。

为什么使用OpenAPI规范

        OpenAPI规范是一种强大的工具,用于设计、构建、文档化和使用RESTful API。通过它,你可以清晰地描述你的API能做什么,以及如何与之交互,而不需要深入了解其背后的代码实现。

        OpenAPI规范的使用可以带来以下好处:

  • 标准化: 提供了一个通用的、与语言无关的API描述。
  • 自动化: 可以生成API文档和客户端库。
  • 交互性: 通过Swagger UI等工具,可以直接与API进行交互。

如何开始使用OpenAPI

  1. 了解基础结构: 学习OpenAPI文档的基本组成部分,如info, servers, paths, 和 components

  2. 编写你的第一个API文档:

    • 确定你的API要解决的问题和提供的服务。
    • 使用info部分提供API的概述。
    • servers部分添加API服务器的URL。
    • 使用paths定义API的不同路径和操作。
    • 如果需要,使用components定义通用的请求和响应结构。
声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/酷酷是懒虫/article/detail/992531
推荐阅读
相关标签
  

闽ICP备14008679号