接口文档格式(待完善)

前景说明:这个版本是自己参考之前整理的  肯定是有不足忘大神补充

具体正文格式如下:

某某项目微信小程序接口(项目名称+详细说明)

1.项目根路径

                 http://ip:port/根路径名称

2.状态码说明

序号

状态码

说明

1

200

访问正常

2

404

访问异常

3

403

访问异常

4

500

接口异常

3.接口

3.1 商品模块

3.1.1查询商品

  •   请求路径:selectCommodityList
  •   请求方法:GET
  •   请求参数

参数名

参数说明

备注

pageSize

每页显示多少

【可选参数】不传则获取所有

pageNum

当前页码

【可选参数】不传则获取所有

  •   响应参数

参数名

参数说明

备注

comId

商品数据id

comName

商品名称

  •   响应数据
{

    "code": 200,

    "msg": "查询成功",

    "data": [{

              "comId": 1,

              "comName": "水果"

    }]

}

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
vue-demo 青否云 vue demo 官网 http://cloud.qingful.com 演示 https://qingful.github.io/jquery-demo/index.html 账号:13253522080 密码:mmmmmm 使用 登录青否云 创建应用 数据设置。 创建数据表。 创建数据表user,引擎和校对默认即可。点击显示结构,添加字段phone,类型选择bigint,长度值为11,其余默认。添加字段password,类型选择text,其余默认。 创建数据表todos,引擎和校对默认即可。点击显示结构,添加字段content,类型选择text,其余默认。添加字段user_id,类型选择int,其余默认。添加字段status,类型选择int,其余默认。 权限设置。 创建密钥,名称Authorization,密钥随便设置。 创建分组,分别创建public和home分组。 组权限,创建home的组权限,并选择Authorization秘钥。 表权限。 创建todos表权限,选择home分组,选择todos数据表,权限勾选查询、新增、更新、删除,密钥选择为空。 创建user表权限,选择public分组,选择user数据表,权限勾选查询、新增,密钥选择为Authorization。 字段。 点击创建字段,选择public分组,user数据表,password字段,值为空,类型选择md5,传值选择是,请求链接选择为空。 点击创建字段,选择home分组,todos数据表,user_id字段,值为Authorization.id。类型为空,传值选择否,请求链接选择为空。 配置下./src/config/config.js中的appid,appkey 运行npm run dev 青否云 一站式后端云服务解决方案。为H5,小程序,APP等应用,提供高效,简单,安全的后端云服务支持。 高效 开发效率 无需开发数据库增删改查,登录授权验证,短信验证码等基础功能。 人员成本 无需运维人员,后端仅需要设计数据库,关联,授权等功能的人员。 运维时间 无需搭建服务器,也无需运维,运维自动化时间节省100%。 简单 sdk集成 sdk一键集成,极速部署,辅助开发文档,开发范例等快速的上手开发。 api接口 api接口采用restful设计方案,拥有结构清晰、符合标准、易于理解、扩展方便等特性。 cdn加速 cdn加速内置,融合主流CDN,加速传输,助力内容极速抵达用户。 安全 jwt授权 JSON Web Token(JWT)是JSON风格轻量级的授权和身份认证规范,可实现无状态、分布式的Web应用授权。使用JWT在用户和服务器之间传递安全可靠的信息。 https传输 https传输是服务器以密文的方式将对称密钥发给客户端(用公钥进行非对称加解密(TLS握手阶段)对称密钥建立受保护区),非对称加密可以很好的管理对称密钥,保证每次数据加密的对称密钥都是不相同的,通过这个对称密钥来进行后续通信的数据加解密。 sla标准 sla可靠性不低于 99.95%,即每月服务故障时长不超过21.6分钟。并且具备完善的故障监控、自动告警、快速定位、快速恢复等一系列故障应急响应机制。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值