页面树结构
转至元数据结尾
转至元数据起始

正在查看旧版本。 查看 当前版本.

与当前比较 查看页面历史

« 前一个 版本 19 下一个 »

开发文档阅读说明

  1. API接口开放了丰富的接口说明,开发者可以借助接口能力,实现FiData的二次开发,通过目录导航可以快速预览,目录树按功能块聚合归类,如数据接入接口,API网关服务接口等。
  2. 文档的阅读次序,建议先阅读一遍开发指南,并关注如何获取token,然后就可以独立查看各个功能块的API接口文档说明。


一、项目目录简介

注:仅对部分重点目录进行介绍。在本文档后续的介绍过程中,约定始终位于项目根目录(./)

./src——项目最重要的文件夹,代码及图片资源等都位于本文件夹

  • ./src/api——存放不同功能模块的请求接口
  • ./src/assets——静态资源文件夹,存放图片及字体资源
  • ./src/components——跨模块组件的存放位置(如:数据接入及数仓建模同时使用了 Example.vue 组件,则将 Example.vue 文件存入本文件夹)
  • ./src/icons——svg图标存放位置
  • ./src/layout——项目布局组件的存放位置,例如侧边栏组件及导航条组件等
  • ./src/mixin——跨模块组件的混入代码内容
  • ./src/router——动态路由及静态路由的配置文件存放位置
  • ./src/store——vuex状态管理文件的存放位置。注:本项目已对./src/modules文件夹做出批量化导入处理。
  • ./src/styles——全局样式文件及跨模块样式文件的存放位置
  • ./src/utils——工具类及对axios进行封装的文件的存放位置。注:不同模块的axios封装处理不同,因此产生了多个封装文件
  • ./src/views——项目组件文件的存放位置


二、项目路由管理


三、接口调用流程

请求接口:所有的接口需使用HTTPS/HTTP协议、JSON数据格式、UTF8编码。接口说明格式如下:

常用请求方式:GET/POST/PUT/DELETE(HTTP)
请求地址:http://10.220.108.140:41004/ (注:请求的api地址及端口号配置于项目根目录下的.env.pudong文件)
详细请求方式请查看“接口文档”中的示例


1) 请求方式,标明接口调用的HTTP方法,区分HttpGet/HttpPost请求。所有的请求都为http/https协议。
2) 请求地址,参数中标注大写的单词,表示为需要替换的变量。在上面的例子中 ID 及 SECRET 为需要替换的变量,根据实际获取值更新。假如,这里我们获取到的ID=wwabcddzxdkrsdv,SECRET=vQT_03RDVA3uE6JDASDASDAiXUvccqV8mDgLdLI,那么上述的请求在发送时为:

https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=wwabcddzxdkrsdv&corpsecret=vQT_03RDVA3uE6JDASDASDAiXUvccqV8mDgLdLI


3) 请求包体/参数说明,标明请求参数示例及说明,参数说明包括字段含义、取值范围,开发者在设计数据结构时,应参考该定义范围。
4) 权限说明,标明接口的使用范围,开发者应特别留意调用场景。比如,同步通讯录的接口必须要用通讯录同步助手的access_token,发送消息指定的范围必须是应用可见范围内的结点等。
5) 返回结果/参数说明,标明返回参数示例及说明。特别留意,所有接口在调用失败时返回包里都有errcode、errmsg(部分接口在调用成功时没有返回errcode和errmsg)。开发者需根据errcode存在且不为0判断为失败,否则为成功(errcode意义请见全局错误码)。而errmsg仅作参考,后续可能会有变动,因此不可作为是否调用成功的判据。

  1. 获取access_token,参考 文档说明。
  2. 缓存和刷新access_token。
    开发者需要缓存access_token,用于后续接口的调用(注意:不能频繁调用gettoken接口,否则会受到频率拦截)。当access_token失效或过期时,需要重新获取。
  3. 调用具体的业务接口


四、组件数据流转


五、基本调试方法

可以使用Postman等工具排查问题原因。


  • 无标签