api接口文档生成工具

_相关内容

HTTP API

路由路径相比API接口往往粒度较粗,如/user/*,这样可快速配置访问路径,实现系统间的交互。HTTP API主要面向开发或运维团队,通过路由可以快速实现业务逻辑的拆分和服务的交互,有较高的灵活性,简化业务系统间的调用逻辑。创建HTTP API ...

快速入门

本文将为您介绍如何接入一路摄像头到VCS平台,并通过API接口使用VCS的智能视觉服务,比如人脸搜索。整体流程 注册阿里云账号 申请开通视觉计算服务 设备导流 VCS购买 创建空间 创建设备 API调用 步骤一 注册阿里云账号 您必须拥有您的阿里...

如何自动生成SDK示例

③ 在搜索框中输入目标API接口,然后在API接口显示后单击API接口。例如输入 DescribeRegions。④ 配置 DescribeRegions 的入参。⑤(非必要步骤)发起调用,若是付费接口将可能产生费用。⑥ 在页面右侧区域的顶部,单击 SDK示例。⑦ 按需...

1.1.5版本

2)支持通过API接口授权外部系统对区行平台主数据元数据进行增删改查 3)新增基于不同行业属性的主数据元数据运营期模板 4)基于定时更新和立即更新的不同策略,从行业平台集中对企业级平台主数据元数据进行更新 5)支持从行业平台集中访问...

调用方式

请注意,您通过API接口传输的数据,请务必进行必要脱敏处理,并确保传输的数据中不包含任何个人信息。SDK调用 参考 阿里云Java SDK开发指南 快速开始,了解如何使用阿里云Java SDK核心包 在pom.xml中引入如下dependency获得新零售智能助理...

API概览

本文列举了AHAS支持的API接口。监控 监控相关的API如下表。API 描述 GetMetricsOfResource 调用GetMetricsOfResource接口获取资源监控数据。流控规则 流控规则相关的API如下表。API 描述 CreateFlowRule 调用CreateFlowRule接口创建流控...

API概览

请注意:开发者通过API接口传输的数据,请务必进行必要脱敏处理,并确保传输的数据中不包含任何个人信息。机器人管理 API 描述 CreateRobot 用于创建一个Robot实例。每新增1个客户,都须调用本接口创建一个Robot、获取RobotCode。...

API概览

我们已经为开发者封装了常见编程语言的SDK,开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入...

API概览

我们已经为开发者封装了常见编程语言的SDK,开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入...

AuthorizedApi

描述 应用API的对应关系 节点名 AuthorizedApi 子节点 RegionId String API所在区域。GroupId String API分组 ID,系统生成,全局唯一。GroupName String API分组名称。StageName String API环境,取值:RELEASE:线上。TEST:测试。...

生成代码

移动网关提供生成 API 的客户端 SDK 功能。关于此任务 只有 HTTP 类型的 API 支持单个代码生成。操作步骤 通过以下的操作方式打开 客户端代码生成 窗口:方式一:在 API 分组 标签页中,点击系统列表操作列中的 生成代码 按钮。方式二:在 ...

API概览

本文汇总了 PolarDB-X 1.0 支持的API接口。实例管理 API 描述 CreateDrdsInstance 该接口用于创建一个 PolarDB-X 1.0 实例。DescribeDrdsInstance 该接口用于查询 PolarDB-X 1.0 实例详情。DescribeDrdsInstances 该接口用于查询 PolarDB-X...

控制台使用指南

功能概览 文档智能控制台包含产品概览、监控统计、服务管理列表、能力广场、轻应用五大模块,其中:产品概览:包含服务管理与开通、操作指引、热门服务推荐以及新手指南和常见问题等内容。监控统计:提供各个服务的调用量统计和QPS统计,并...

下载调用文档

您可以将API接口调用文档下载到本地,以便进行查看,支持Word和PDF两种格式。数据服务API、数据上报API、三方API、空间服务API 的调用文档下载方式相似,本文以数据服务API为例介绍如何下载调用文档。前提条件 已创建API。操作步骤 登录 ...

Java SDK使用指南

查看OpenAPI文档 在调用OpenAPI前,建议您先阅读对应接口文档,了解、学习调用该接口所需要的参数及权限等。更多信息,请参见 API概览。准备工作 在使用Java语言SDK方式调用OpenAPI之前,请您完成如下准备工作。准备Java SDK环境 在使用...

WebOffice计费说明

Weboffice计费模式在2023-12-01调整成按照API接口调用次数计费,涉及的API接口包括,GenerateWebofficeToken-获取Weboffice凭证 和 RefreshWebofficeToken-刷新Weboffice凭证。此次调整只对2023-12-01以后创建的项目生效,不影响在此之前...

请求结构

URL 中包含如下:服务地址 通讯协议 请求方法 公共头参数 每个 API 的特有参数 每篇 API 文档均给出了 URL 请求示例供您参考,我们并没有编码这些 URL 示例,您需要在发起请求前自行编码。如果你使用 SDK 来发起 API 请求,您只需要设置...

PHP SDK使用指南

查看OpenAPI文档 在调用OpenAPI前,建议您先阅读对应接口文档,了解、学习调用该接口所需要的参数及权限等。更多信息,请参见 API概览。准备工作 在使用PHP语言SDK方式调用文档智能解析的OpenAPI之前,请您完成如下准备工作。环境准备 准备...

新手指引

快速使用文档智能服务 文档智能产品提供API接口、控制台可视化轻应用、小程序等多种使用方式,您可以灵活地采取各种接入方案:通用文档智能 API概览 控制台使用指南 小程序使用指南 行业文档智能 API概览 控制台使用指南 常见问题 产品功能...

Python SDK使用指南

本文介绍如何使用阿里云Python语言SDK开发包调用文档智能解析 API 接口,从文档中提取出层级结构、文本内容、KV字段、样式信息等。准备工作 在使用Python语言SDK方式调用文档智能解析的OpenAPI之前,请您完成如下准备工作。环境准备 下载并...

管理应用接口

接口管理对应用接口定义进行统一管理,支持根据代码中的@RestController 等注解,进行接口扫描并上报回平台。本文介绍如何配置接口管理规则、新建接口和数据模型。新建或导入接口 新建接口 登录BizWorks,在 选择平台 下拉列表中选中 微...

管理消费者

云原生API网关通过消费者来为路由、API开启认证能力,本文介绍云原生API网关控制台如何管理消费者。创建消费者 云原生API网关为您提供了三种认证方式。配置方式 说明 场景适用 API Key 客户端需将凭证按指定方式添加到请求中,网关验证其...

创建消费者

AI 网关通过消费者来为路由、API开启认证能力,本文介绍AI网关控制台如何管理消费者。操作步骤 登录 AI网关控制台。在左侧导航栏,单击 消费者,并在顶部菜单栏选择地域。在 消费者 页面左上角,单击 创建消费者。在 创建消费者 页面,填写...

设置官网开放内容

通过开放设置功能您可以将生成的接口定义相关接口文档在开放门户展示。本文介绍如何设置官网开放内容。操作步骤 登录BizWorks,在 选择平台 下拉列表中选中 能力开放平台。单击 运营 页签。在 能力开放平台 导航栏中,选择 能力开放门户 ...

应用开发 API 说明

说明 注意:与阿里云 OpenAPI 不同,IDaaS 应用开放的 Developer API 依赖于 IDaaS 中应用的密钥,并在 IDaaS 应用管理中分配接口调用权限。Developer API 权限不依赖于 RAM。SDK、样例代码和调试 推荐您使用 SDK 调用接口。通过 阿里云 ...

HttpApiOperation

GetUserInfo path string 接口路径。user description string 接口描述。获取用户信息 response HttpApiResponseContract 接口响应参数定义。request HttpApiRequestContract 接口请求参数定义。mock HttpApiMockContract 接口 Mock 配置,...

API 概览

具体接口信息参见相关接口文档。环境接口 账户接口 合约接口 查询接口 本地执行接口 原生存证接口 事件接口 辅助工具类接口 环境接口 接口 描述 Chain 环境实例初始化 账户接口 接口 描述 CreateAccount 创建账户 TransferBalance 转账 ...

HttpApiOperationInfo

名称 类型 描述 示例值 object 接口信息。operationId string 接口 ID。op-xxx method string 接口方法。枚举值:TRACE:TRACE。HEAD:HEAD。DELETE:DELETE。POST:POST。GET:GET。CONNECT:CONNECT。OPTIONS:OPTIONS。PUT:PUT。PATCH...

HttpApiOperationInfo

名称 类型 描述 示例值 object 接口信息。operationId string 接口 ID。op-xxx method string 接口方法。枚举值:TRACE:TRACE。HEAD:HEAD。DELETE:DELETE。POST:POST。GET:GET。CONNECT:CONNECT。OPTIONS:OPTIONS。PUT:PUT。PATCH...

快速创建一个生成漫画插图接口

从0到1快速创建一个生成漫画插图接口 本教程将指导您从零开始,快速创建一个生成漫画插图的API接口。方案概览 用户自己手动在智作工坊控制台创建对应的应用,调试需要的工作流,并且发布为一个可以调用的接口,之后使用对应的语言的 SDK 接...

API接口列表中配置插件规则

云原生API网关支持为API接口挂载插件规则,提供灵活且安全的API管理服务,增强服务的可扩展性。本文主要介绍如何在API接口列表中为指定的API或者接口挂载插件规则。说明 在API接口挂载插件规则时,若网关实例未安装插件,支持一键...

API概览

云原生数据库PolarDB 提供以下相关API接口。地域 API 描述 DescribeRegions 该接口用于查询 PolarDB 支持的地域和可用区。集群 类别 API 描述 集群管理 CreateDBCluster 该接口用于创建 PolarDB 集群。DeleteDBCluster 该接口用于释放按量...

API概览

云原生数据库PolarDB 提供以下相关API接口。地域 API 描述 DescribeRegions 该接口用于查询 PolarDB 支持的地域和可用区。集群 类别 API 描述 集群管理 CreateDBCluster 该接口用于创建 PolarDB 集群。DeleteDBCluster 该接口用于释放按量...

性能数据

列表中的API接口共享这一组配额。GetParametersForImport DescribeKey ListKeys DescribeKeyVersion ListKeyVersions GetPublicKey ListAliases ListAliasesByKeyId ListTagResources DescribeRegions 50次/秒 查询密钥标签。...

插件市场

本文旨在为您详细介绍在云原生API网关中如何使用、管理、开发和上传插件,以及如何在API接口列表中为指定的API或者接口挂载插件规则。此外,还将指导您通过WebIDE一站式完成自定义插件的开发和编译。使用Lua插件 在云原生API网关开发中,...

观测分析

本文旨在为您介绍API网关如何查看网关监控数据、在云原生API网关开启日志投递、云原生API网关开启链路追踪、云原生API网关开启Metrics投递、以及如何通过云原生API网关查看REST API接口的监控数据。这些功能将帮助您更高效地管理和优化...

事件总线

本环节用于API帮助文档的自助生成,帮助API使用者更好地理解。可以设置返回结果示例和失败返回结果示例。本例中不涉及到这部分,因此可以单击创建按钮。发布API。对API进行过任何的配置,都需要发布到对应的环境中才能生效。本例中在创建后...

释放云原生API网关实例

如果您无需再使用云原生API网关,可以通过释放实例来关闭云原生API网关。注意事项 实例释放后,该实例将会被删除,其数据均被删除,请谨慎操作。仅按量付费模式的实例...相关文档 如您需使用SDK删除API接口,请参见 DeleteGateway-删除网关。

AI生成合成内容鉴别和标识最佳实践

所需集成和配置的API:模态 API接口 API service配置 图片是否AI生成合成检测 ImageModeration aigcDetector aigcDetectorFull aigcDetector_pro 文本是否AI生成合成检测 TextModerationPlus text_aigc_detector 语音是否AI生成合成检测 ...

Android SDK

SDK接入流程 步骤 集成内容 文档中的位置 是否必选 附加说明 第一步 引入SDK 查看文档「引入&配置SDK」-1.引入SDK 必选 第二步 配置权限 查看文档「引入&配置SDK」-2.配置权限 必选 第三步 混淆配置 查看文档「引入&配置SDK」-3.混淆配置 ...
< 1 2 3 4 ... 200 >
共有200页 跳转至: GO
新人特惠 爆款特惠 最新活动 免费试用