展开

关键词

首页关键词api使用规范

api使用规范

API(ApplicationProgrammingInterface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。

相关内容

API 网关

API 网关

API 全生命周期托管服务
  • BaaS API 设计规范

    概要BAAS 平台上的所有 API,必须严格遵守本规范。通过本文档规范 BAAS 平台所有向外提供 API,体现技术的统一性、规范性。并使得所有 API 尽量靠近业界规范的同时,提高API的易用性、可读性、兼容性等,并方便平台的使用者更快地发现、熟悉所有API以供开发。主要包含两个方面的规范:API 本身的设计规范、API 帮助文档的编写规范。1.2. 参考资料《Representational State Transfer (REST)》1.3.API 设计规范2.1.API 帮助文档规范BAAS 平台中的 API 帮助文档将采用统一的格式编写,并以 HTML 页面的形式发布。帮助文档使用以下地址:GET apiv1.1 返回 1.1 版本 API 的帮助文档首页。
    来自:
    浏览:397
  • Web API接口规范与测试方法

    2.接口规范(restful)RESTful(Representational State Transfer)是目前较为流行的Web API 的设计规范,特点:简单、易上手。用api关键字标识接口url: https:api.baidu.comhttps:www.baidu.comapi 注:看到api代表该请求url链接是完成前后台数据交互的。2.1.3 多数据版本共存如果一个资源存在多版本结果,在url链接中要用特定符号来兼容多版本共存如v1,v2 https:api.baidu.comv1https:api.baidu.comv2 注:url:api.baidu.combook 注:一般提倡用资源的复数形式,在url链接中尽量不要出现操作资源的动词,错误示范:https:api.baidu.comdelete-user特殊的接口可以出现动词5.Pycharm debug窗口的使用5.1 操作步骤:5.1.1添加断点:直接在标记处点击鼠标左键即可。
    来自:
    浏览:765
  • 政策与规范

    腾讯云服务协议,对象存储服务等级协议(SLA),云安全违规处罚等级划分说明,云市场用户协议V1.0,云+众创计划申请书,安全违规处理帮助指引,腾讯云隐私声明,腾讯云客户数据常见问题,移动推送 TPNS,云数据库服务等级协议(SLA),弹性缓存服务等级协议(SLA),内容分发网络服务等级协议(SLA),消息队列 CKafka 服务等级协议(SLA),腾讯微服务平台服务等级协议(SLA),API 网关服务等级协议(SLA),云访问安全代理服务等级协议(SLA),汽车精准获客服务服务等级协议(SLA),医疗报告分类 SaaS 服务等级协议(SLA),医疗报告结构化 SaaS 服务等级协议(SLA),禁止使用腾讯云服务从事任何虚拟货币相关活动的声明,云数据库服务等级协议(SLA),弹性缓存服务等级协议(SLA),内容分发网络服务等级协议(SLA),消息队列 CKafka 服务等级协议(SLA),腾讯微服务平台服务等级协议(SLA),API 网关服务等级协议,医疗报告结构化 SaaS 服务等级协议(SLA),禁止使用腾讯云服务从事任何虚拟货币相关活动的声明,身份安全,数字身份管控平台服务等级协议(SLA),DDoS 高防 IP 服务等级协议(SLA),智能导诊服务等级协议
    来自:
  • 广告
    关闭

    腾讯云+社区「校园大使」招募开启!报名拿offer啦~

    我们等你来!

  • 镜像服务和 API 类商品配图规范

    所以云市场对于配图清晰、有实质内容、有吸引力的商品会给予更多的曝光。为了让商品能够更高效的通过上架审核,您需要遵循云市场提供的配图规范,并且只有遵循配图规范的商品才有机会出现在首页等推荐位上。以下是镜像服务和 API 类商品配图设计规范,您可以查看以下模板中的规范说明,并下载云市场提供的 镜像服务和 API 类商品配图规范 快速生成配图。注意: 以下配图模板仅限于服务商在腾讯云云市场页面内展示使用。模板内容仅作为参考样式提供,请按照商品实际内容填充,并且模板的布局、颜色和字体均可根据商品实际内容进行变动设计。
    来自:
  • 云 API

    词汇表,产品概述,购买指南,API 使用问题,SDK 使用问题,入门必读,使用 API Explorer,使用 TCCLI,C++ API,.NET API,GO API,Java API,Node.jsAPI,PHP API,Python API,应用场景,使用腾讯云 API 平台,使用 API Inspector,使用云 API 控制台,查询产品可用区列表,查询产品支持的地域列表,数据结构,请求结构,公共参数,签名方法 v3,签名方法,返回结果,错误码,简介,API 概览,更新历史,词汇表,常见问题,快速入门,开发指南,产品概述,购买指南,API 使用问题,SDK 使用问题,入门必读,使用 APIExplorer,使用 TCCLI,C++ API,.NET API,GO API,Java API,Node.js API,PHP API,Python API,产品简介,应用场景,使用腾讯云 API平台,使用 API Inspector,使用云 API 控制台,API 文档,API控制台相关接口,查询产品可用区列表,查询产品支持的地域列表,数据结构,调用方式,请求结构,公共参数,签名方法 v3,
    来自:
  • 云市场

    云市场概述,镜像服务,人工服务,SaaS 服务,平台费用说明和保证金规则,云市场管理规范,入驻流程,API 服务,订单改价流程,镜像安全审核标准,云市场服务商子账号设置流程,关于用户联系电话隐私保护服务升级通知,镜像服务和 API 类商品配图规范,发票申请流程,发票相关问题,保证金缴纳管理,收益提现操作管理,自动交付接入方案,优惠券管理,优惠券领取和使用,服务商店铺页 Banner 设计规范,2020年云市场服务商信用分数管理办法,镜像相关问题,千帆计划概述,小程序相关问题,查询使用计划使用量,请求结构,公共参数,签名方法 v3,签名方法,返回结果,错误码,简介,API 概览,更新历史,计量商品用量提醒,服务商入驻,商品接入,云市场概述,企业服务和运维服务商品配图规范,镜像服务和 API 类商品配图规范,发票申请流程,发票相关问题,保证金缴纳管理,收益提现操作管理,自动交付接入方案,优惠券管理,优惠券领取和使用,服务商店铺页 Banner设计规范,2020年云市场服务商信用分数管理办法,镜像相关问题,千帆计划概述,小程序相关问题,API 文档,已购实例相关接口,查询使用计划使用量,业务信息相关接口,调用方式,请求结构,公共参数,签名方法
    来自:
  • 云 API

    云 API 是腾讯云开放生态的基石。通过云 API,只需执行对应 API 命令行工具即可快速操作云产品;在熟练的情况下,使用一些频繁使用的功能,使用云 API 可以极大的提高效率;除此之外,通过API可以组合功能,实现更高级的功能,易于自动化
    来自:
  • API 网关

    产品概述,产品优势,产品功能,应用场景,调用密钥对认证 API,创建服务,编辑服务,服务删除,配置自定义域名,创建 API 概述,服务发布与下线,发布后访问,环境版本切换,查看访问监控,使用计划概述,使用计划示例查询 API 接口列表,查询 API 使用计划详情,查询API详情,删除API,创建API,数据结构,错误码,简介,API 概览,更新历史,规则说明,概述,安装 Serverless Framework,修改插件,插件解绑API,查询插件绑定的API列表,查询插件详情,展示插件相关的API列表,删除插件,插件绑定API,更新应用秘钥,解除应用和API绑定关系,修改应用,应用使用者查询服务详情,查询Api,编辑服务,服务删除,配置自定义域名,管理 API,创建 API 概述,发布与访问,服务发布与下线,发布后访问,环境版本切换,查看访问监控,使用计划,使用计划概述,使用计划示例,认证与安全,认证与安全概述策略,API相关接口,增量更新API接口,修改API,查询 API 接口列表,查询 API 使用计划详情,查询API详情,删除API,创建API,数据结构,错误码,简介,API 概览,更新历史,API
    来自:
  • 云数据库 MySQL 使用规范

    目的规范化对云数据库 MySQL 的管理和维护,避免操作不当对云数据库 MySQL 造成不可用等影响。指导数据库开发人员合理编写 SQL,发挥云数据库 MySQL 最优性能。权限管理规范考虑到云数据库 MySQL 的稳定性和安全性,云数据库 MySQL 限制了 super、shutdown、file 权限,有时在云数据库 MySQL 上执行 set 语句时,会出现如下的报错日常操作规范注意事项禁止使用弱密码,提升数据库实例安全性。内网连接登录须确保 client 端的云服务器 CVM 与云数据库 MySQL 是同一账号同一地域的机器。库表设计规范注意事项云数据库 MySQL 5.6 及以上版本不支持 MyISAM 引擎和 Memory 引擎,若有 Memory 引擎的需求建议使用云数据库 Redis 、Memcached;自建数据库迁移到云数据库SQL 编写规范注意事项UPDATE、DELETE 操作不使用 LIMIT,必须走 WHERE 精准匹配,LIMIT 是随机的,此类操作会导致数据出错。
    来自:
  • 什么是RESETful API 设计规范?

    image.png现在在开发中前后端都是分离开发,后端提供接口给前台,RESTful 架构,就是目前最流行的一种互联网软件架构,也相当于是接口规范关于「能愿动词」的使用为了避免歧义,文档大量使用了「能愿动词API 与后端服务通信的过程中,应该 使用 HTTPS 协议域名API 应该部署在专用域名之下,应尽可能保持足够简单。遵守 HTTP 设计规范,必须 选择合适的 HTTP 状态码。目前常见返回错误信息的方法有两种:将错误详细放入 HTTP 响应首部直接放入响应实体中建议参考理解RESTful架构RESTful API 设计指南RESETful API 设计规范 沈唁志|一个PHPer原创文章采用CC BY-NC-SA 4.0协议进行许可,转载请注明:转载自:什么是RESETful API 设计规范?
    来自:
    浏览:1605
  • RESTful API 设计规范

    作者:马一特cnblogs.commayitep9798913.htmlRESTful 是目前最流行的 API 设计规范,用于 Web 数据接口的设计。它的大原则容易把握,但是细节不容易做对。本文总结 RESTful 的设计细节,介绍如何设计出易于理解和使用的 API。5种HTTP请求方法,对应CRUD操作,根据 HTTP 规范,动词一律大写。的使用者未必知道,URL 是怎么设计的。举例来说,GitHub 的 API 都在 api.github.com 这个域名。访问它,就可以得到其他 URL。
    来自:
    浏览:351
  • RESTful API 设计规范

    本文转载自:https:github.comgodruoyirestful-api-specification作者:godruoyi该仓库整理了目前比较流行的 RESTful api 设计规范,为了方便讨论规范带来的问题及争议2119Protocol客户端在通过 API 与后端服务通信的过程中,应该 使用 HTTPS 协议。,那 应该 将 API 放到子域下(api.example.com)。至于具体把版本号放在什么地方,这个问题一直存在很大的争议,但由于我们大多数时间都在使用 Laravel 开发,应该 使用 dingoapi 来快速构建应用,它采用第二种方式来管理 API版本,并且已集成了标准的Response所有的 API 响应,必须 遵守 HTTP 设计规范,必须 选择合适的 HTTP 状态码。
    来自:
    浏览:598
  • RESTful API 规范 v1.0

    本文作者:IMWeb 梁伟盛 原文出处:IMWeb社区 未经同意,禁止转载 RESTful API 规范 v1.0URIURI规范不要用大写单词间使用下划线_不使用动词,资源要使用名词复数形式,如:user、rooms、tickets层级 >= 三层,则使用?非id的参数使用?limit=10&offset=10limit:返回记录数量offset:返回记录的开始位置单参数多字段使用, 分隔,如 users1?第三个层次(Level 2)的 Web 服务使用不同的 HTTP 方法来进行不同的操作,并且使用 HTTP 状态码来表示不同的结果。
    来自:
    浏览:174
  • RESTful API 规范 v1.0

    本文作者:IMWeb 梁伟盛 原文出处:IMWeb社区 未经同意,禁止转载 RESTful API 规范 v1.0URIURI规范不要用大写单词间使用下划线_不使用动词,资源要使用名词复数形式,如:user、rooms、tickets层级 >= 三层,则使用?的参数使用?limit=10&offset=10limit:返回记录数量offset:返回记录的开始位置单参数多字段使用, 分隔,如 users1?第三个层次(Level 2)的 Web 服务使用不同的 HTTP 方法来进行不同的操作,并且使用 HTTP 状态码来表示不同的结果。
    来自:
    浏览:461
  • Serverless HTTP 服务

    Serverless HTTP 基于腾讯云 API 网关平台,为互联网业务提供 0 配置、高可用、弹性扩展的对外 RESTful API 能力,支持 swagger/ openAPI 等协议。便于客户快速上线业务逻辑,通过规范的 API 支持内外系统的集成和连接。
    来自:
  • API 接口设计规范

    概述这篇文章分享 API 接口设计规范,目的是提供给研发人员做参考。规范是死的,人是活的,希望自己定的规范,不要被打脸。安全规范敏感参数加密处理登录密码、支付密码,需加密后传输,建议使用 非对称加密。其他规范参数命名规范 建议使用驼峰命名,首字母小写。requestId 建议携带唯一标示追踪问题。其他规范属性名命名时,建议使用驼峰命名,首字母小写。属性值为空时,严格按类型返回默认值。金额类型时间日期类型的属性值,如果仅用来显示,建议后端返回可以显示的字符串。签名设计签名验证没有确定的规范,自己制定就行,可以选择使用 对称加密、 非对称加密、 单向散列加密 等,分享下原来写的签名验证,供参考。日志平台的搭建可以使用的是 ELK 组件,使用 Logstash 进行收集日志文件,使用 Elasticsearch 引擎进行搜索分析,最终在 Kibana 平台展示出来。
    来自:
    浏览:1021
  • 云数据库 MySQL

    ,回档相关,备份常见问题,扩展实例问题,性能相关问题,控制台相关,数据迁移,运维相关,连接实例相关问题,管理只读实例 RO 组,云数据库 MySQL 使用规范,授权策略语法,可授权的资源类型,控制台示例,访问管理概述,退费说明,简介,API 概览,请求结构,公共参数,签名方法,返回结果,查询云数据库备份配置信息,修改数据库备份配置,查询备份数据库列表,删除云数据库备份,查询数据备份文件列表,查询二进制日志备份文件列表文档,通用参考,数据库实例,应用场景,使用限制,数据库实例类型,创建只读实例,管理灾备实例,备份与回档,回档数据库,数据库实例复制,数据库管理(DMC),维护管理实例,升级数据库引擎版本,监控与告警,,常见问题,功能特性,参数修改,回档相关,备份常见问题,扩展实例问题,性能相关问题,控制台相关,数据迁移,运维相关,连接实例相关问题,管理只读实例 RO 组,云数据库 MySQL 使用规范,访问管理,授权策略语法,MySQL 主实例参数修改的影响,通过 Python 语言使用 MySQL API,实例购买,实例管理,备份任务,修改云数据库实例的自动续费标记,调整数据库实例规格,续费说明,操作指南,升级版本,扩展实例
    来自:
  • 云数据库 MariaDB

    产品概述,应用场景,系统架构,重命名数据库实例,计费概述,读写分离,解压备份和日志文件,升级计费,服务等级协议,续费说明,欠费说明,分布式版本,通过备份文件恢复实例,数据库审计,数据库审计已支持语法,编程与使用规范,分布式版本编程与使用规范,注意事项,监控功能,告警功能,使用 DTS 工具导入数据到 MariaDB 实例,签名方法,创建帐号,查看帐号列表,删除帐号,设置权限,获取权限列表,复制权限,修改帐号备注,概览,请求结构,公共参数,签名方法,返回结果,修改备份日志保存天数,查看备份日志备份天数,修改数据库参数,查看数据库参数,查看实例性能数据详情,查看实例资源使用详情,查看实例资源使用情况,查询慢查询日志列表,分布式版本编程与使用规范,快速入门,注意事项,监控与告警,监控功能,告警功能,使用 DTS 工具导入数据到 MariaDB 实例,API概览,更新历史,调用方式,签名方法,使用示例,帐号相关接口,备份与恢复相关接口文档,信息安全说明,使用前须知,迁移数据,使用 mysqldump 导入数据,升级规格版本,升级数据库引擎版本,升级数据库实例规格,下载备份文件,备份方式,参数模板与设置,自定义备份时间,为实例指定项目
    来自:
  • 云数据库 MongoDB

    概览,请求结构,公共参数,接口鉴权 v3,接口鉴权,返回结果,更新历史,升级云数据库实例(按量计费),升级云数据库实例(包年包月),销毁云数据库实例(按量计费),创建云数据库实例(按量计费),创建云数据库实例,简介,API 概览,请求结构,公共参数,签名方法 v3,签名方法,返回结果,更新历史,修改实例名称,下线隔离状态的云数据库实例,调整云数据库实例配置,隔离云数据库实例,查询云数据库的售卖规格,查询云数据库实例列表新手指引,Go 连接示例,切换网络,查询备份下载任务信息,创建备份下载任务,查询实例绑定的安全组,开发规范,产品简介,使用限制,产品概述,产品优势,购买指南,计费概述,创建 MongoDB 实例,续费说明文档,MongoDB API概览,调用方式,实例相关接口,修改实例名称,修改实例项目,创建实例(包年包月),升级实例(包年包月),查询任务结果,查询实例价格(包年包月),查询实例列表,查询订单详情,续费实例,免认证访问,基本概念,新手指引,Go 连接示例,切换网络,查询备份下载任务信息,创建备份下载任务,查询实例绑定的安全组,开发规范
    来自:

扫码关注云+社区

领取腾讯云代金券