复制API

通过API复制功能,用户可以快速基于已有的API创建新的副本,从而减少重复性工作。复制完成后,用户可以根据实际需求修改API副本的详细信息,如名称、描述、请求参数、响应参数等。

操作流程

  1. 选择并复制API
    • 用户在API列表中找到并选择一个已有的API。
  1. 点击“复制”按钮:

image-(7)

API列表中,点击页面上的“复制”按钮以触发API复制操作。

    • 点击“复制”按钮后,系统会在页面右侧弹出一个抽屉样式的侧边栏,展示被复制的API信息。

image

    • 在抽屉中展示被复制API的详细信息:
      • 基础信息:展示API的名称、API URL、API描述基础属性。
      • 请求参数:显示当前API的请求参数配置,方便用户检查和修改。
      • 响应结果:显示API的响应结果定义,用户可以根据需要进行调整。
  1. 修改API基础信息:
    • 用户可以在抽屉中对新API的基础信息进行编辑,如:
    • 调整API名称。
    • 调整API URL。
    • 修改API描述。
    • 编辑请求参数或响应参数。
  1. 点击“保存”按钮:
    • 用户完成修改后,点击抽屉中的“保存”按钮以确认新API的创建。
  1. 后续可对此API的操作:
    • 查看:查看新API的详细信息。
    • 编辑:对新API进行配置修改,如更改参数、更新描述等。
    • 删除:如果不需要,可以删除该API
    • 启用/禁用:控制API的启用状态,根据需求可以随时启用或禁用该API。

注:

  1. 技术名称:
    • 技术名称字段在复制时不进行回填,无论原API的技术名称是手动输入还是自动生成的。用户需要在复制API时手动输入新API的技术名称。
  1. API名称:
    • 系统自动为新API生成名称,格式为API名称_复制。如果已经多次复制该API,系统将自动累加名称,如API名称_复制、API名称_复制_复制。

本文来自投稿,不代表Oinone社区立场,如若转载,请注明出处:https://doc.oinone.top/chan-pin-shi-yong-shou-ce/17535.html

(0)
萧炎的头像萧炎数式员工
上一篇 2024年9月20日 am10:59
下一篇 2024年9月20日 pm1:47

相关推荐

  • 系统配置

    系统配置模块帮助企业在平台中实现个性化,以满足不同的业务需求和企业文化展示。该模块主要包含二个部分:全局配置、应用配置。

    2024年8月30日
    82500
  • 跳转到其他页面并刷新页面

    本节介绍如何在界面设计器中为页面的“跳转动作”按钮配置强制刷新标签页功能,使用户切换标签页时,内容可以根据需要自动刷新或保持之前的状态。

    2024年9月20日
    66900
  • 管理中心

    管理中心由原「合作伙伴中心」「用户中心」「权限」3部分构成。

    2024年8月29日
    74700
  • 使用GraphQL生成API文档

    GraphiQL 是一个非常流行的交互式开发环境(IDE),专门用于浏览、编写和测试 GraphQL 查询。它不仅可以帮助你查询 API,还可以自动生成文档。以下是如何使用 GraphiQL 的具体步骤: 仓库地址:https://github.com/anvilco/spectaql?tab=readme-ov-file#yaml-options 一、使用GraphiQL 工具生成API文档。 1. GraphiQL 安装与配置 方式 : 本地或全局安装 GraphiQL 如果你的 GraphQL API 服务器没有内置 GraphiQL,你可以使用独立的 GraphiQL 框架或包。 全局安装 GraphiQL如果你想在本地环境使用 GraphiQL,你可以通过 npm 或 yarn 安装:如果下载不成功可以使用淘宝镜像源 npm install -g graphiql 通过 npm 或 Yarn 安装为开发依赖你也可以将 GraphiQL 作为开发依赖安装到项目中: npm install graphiql 生成您的文档! npx spectaql config.yml 运行此命令你需要一份config.yml文件。具体使用参考https://github.com/anvilco/spectaql?tab=readme-ov-file#yaml-options 2. 使用JSON格式生成文档 生成或导出 schema 文件 自动生成 schema如果你使用的是 Java 类和注解方式定义的 GraphQL API(使用 @GraphQLQuery 等注解),GraphQL schema 通常在运行时生成。你可以使用 Spring Boot 启动后访问 GraphQL endpoint 来手动导出 schema。 访问 GraphQL Endpoint:在应用运行时,GraphQL API 通常暴露在 /graphql 路径下。你可以通过 introspection 查询导出完整的 GraphQL schema。 下面是一个 introspection 查询的示例,它可以帮助你获取 schema:这个查询可根据文档需要动态调整。查询http://127.0.0.1:8091/pamirs/graphql,注意保证工程yml配置文件pamirs.framework.gateway.show-doc: true为开启状态。 query IntrospectionQuery { __schema { queryType { …FullType } mutationType { …FullType } subscriptionType { name } types { …FullType } directives { name description locations args { …InputValue } } } } fragment FullType on __Type { kind name description fields(includeDeprecated: true) { name description args { …InputValue } type { …TypeRef } isDeprecated deprecationReason } inputFields { …InputValue } interfaces { …TypeRef } enumValues(includeDeprecated: true) { name description isDeprecated deprecationReason } possibleTypes { …TypeRef } } fragment InputValue on __InputValue { name description type { …TypeRef } defaultValue } fragment…

    2024年9月13日
    81800
  • 跳转动作新增默认生成视图

    在跳转动作的配置中,针对用户在选择创建新页面时需要重新拖动字段到设计器区的操作,新增了“默认生成视图”功能。这一功能可以自动生成页面视图,简化了设计流程,提升了操作效率。

    2024年9月20日
    68500

Leave a Reply

登录后才能评论