thinkphp5 接口管理

接口列表

接口分组管理这里就不在叙述,就是为了给接口归类。本文来源于:http://www.onebase.org/

上图为接口列表页,左上角有两个按钮,一个是新增接口,一个是接口文档跳转按钮。

数据列表中 第1列为 接口名称,第2列为接口分组,第3列为接口请求类型,OneBase默认统一POST类型,当然需要其他类型如GET 可自行扩展,第4列为接口地址也就是 (控制器/方法),第5列是接口目前的状态,接口状态中的选项在系统设置的API栏目下可进行配置,第6列为研发者,研发者成员也在系统设置的API栏目下配置,后面两列为接口排序与操作,接口排序为同级有效。


接口新增

^_^。 虽然表单数据数据有点多,但是不要怕蛤,咱们来一个一个讲解。

咱们按从左往右,从上往下进行编号讲解,比如 1 2 3 4 对应的是 接口名称,接口排序值,请求地址,请求类型。

1:API接口名称,就是用来看滴。。

2:接口排序值,用来进行接口显示排序,这些都很好理解啦。

3:请求地址,接口访问地址格式(控制器/方法)。

4:请求类型,默认为POST,需要其他类型可自己扩展。

5:是否为分页接口,意思就是这个接口是否需要分页功能,如果需要分页功能可传递相关参数,如:list_rows 每页显示的数据量,page 查询的页码。

6:研发者,此接口的研发人员,选项中的可选值可在系统设置的API分组下进行配置。

7:请求数据,意思就是执行此接口是否需要带请求参数,默认为否不带请求数据,此处的请求数据控制的为接口所依赖的请求参数,大家可以打开 https://onebase.org/api.php 看到里面这些接口 下面有个测试接口功能,此处测试接口功能的表单就是根据这里请求数据设置自动生成的,Token与分页参数是不受此处控制的。

8:响应数据,意思就是接口执行成功后返回的数据,默认为否不带返回数据,为是 则可添加接口返回的数据,当然也会有特殊数据 如 分页数据及后面将介绍的数据签名 等。

9:接口分组,这个就不介绍啦。

10:接口状态,这个也飘过吧。

11:接口响应示例,这个是用来给接口调用者看的,方便接口调用者可一眼看清数据结构,提升团队研发效率。

12:接口简介,用来看滴。

13:是否验证用户令牌:user_token, 用来做身份验证滴,比如 文章列表接口,所有的访问者不需要登录也可以看到,就设置为否,这样接口调用就不需要带user_token,若 为需要身份验证的接口,如 订单列表,某个会员只能查看自己的订单,就需要用到user_token啦,所以 像 订单管理,个人中心等 这些接口是需要带 user_token的。user_token 是调用登录接口后返回的,所以若终端想调用需要身份验证的接口,则需要 先调用登录接口后将接口中返回的 user_token 保存下来,在后续接口调用过程中使用。

14:是否响应数据签名:data_sign,此处是用于做数据安全验证的,比如咱们服务器给终端返回了数据,但是 终端那边怎么知道真滴是咱们返回的呢。。此时 data_sign 就派上用场啦。 返回的数据中带上了 data_sign 字段,终端根据服务器返回的数据进行与服务器端相同的算法,计算出 终端的 data_sign,然后两端的 data_sign 进行比对,若一模一样,则说明 数据是一模一样滴,这样就很安全啦,别人想改也不行,嘿嘿。

15:是否验证请求数据签名:data_sign,原理是一样滴,意思就是 终端像接口提交数据时,咱们服务器端也得知道提交的数据是否安全,所以 咱们也要根据提交上来的数据 生成 data_sign,与提交数据中带的data_sign,进行比对,不一样的话就不执行操作,接口返回数据签名不对,一样的话就放行。

16:这个是备用的。。担心服务端人员太腻害,研发出来的接口实在是用言语无法表达。。就可以用富文本进行图文描述。。

好啦,输入选项介绍完了,咱们看下登录接口的编辑数据页面,看看是咋输入滴。

后台接口管理功能就介绍到这里,更深一步将在接口研发中讲解。thinkphp5

时间: 2024-11-05 21:55:03

thinkphp5 接口管理的相关文章

可视化接口管理工具RAP,模拟数据,校验接口

最近看到一个不错的接口管理的工具,分享一下 RAP ppt介绍:http://www.imooc.com/video/11060 RAP是一个可视化接口管理工具 通过分析接口结构,动态生成模拟数据,校验真实接口正确性, 围绕接口定义,通过一系列自动化工具提升我们的协作效率. 使用网址:http://rap.taobao.org/ GitHub地址:https://github.com/thx/RAP 一些文档:https://github.com/thx/RAP/wiki/home_cn 官网:

ERPSYSTEM开发教程05 框架接口管理

框架接口是采用类厂来管理的 一个接口要被框架管理的实现步骤 首先是接口定义,接口实现类,接口实例创建函数,指定类厂 unit BplOneIntf; {$WEAKPACKAGEUNIT ON} interface type IBplOne=interface ['{E4C1C5FA-C598-4834-9111-26B52634068D}'] function Add(A,B:Integer):integer; function Sub(A,B:Integer):Integer; end; im

Flask框架学习笔记(API接口管理平台 V2.0)

博主今天把API接口管理平台发布到github了,这次是更新一些功能 如支持本地数据库sqlite3.优化了数据结构 技术方面跟之前V1.0相同,只增加生产本地数据:但是为了支持层级的参数,修改了数据结构,下面是新的model.py 1 #!/usr/bin/env python 2 # -*- coding: utf-8 -*- 3 4 from app import db 5 6 7 class User(db.Model): 8 user_id = db.Column(db.Integer

(Swagger)一个终端和后台开发对api接口管理工具

Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步.Swagger 让部署管理和使用功能强大的API从未如此简单. 为了方便的管理项目中API接口,在网上找了好多关于API接口管理的资料,感觉目前最流行的莫过于Swagger了,功能强大,UI界面漂亮,并且支持在线测试等等 Swagger – The World

基于python的API接口管理平台开发(V1.0)

今天博主终于完成了API接口管理平台,最后差的就是数据库的维护, 博主这里介绍下平台的设计原理,首先基于python,利用flask的web框架+bootstrap前端框架完成,先阶段完成了前台展示页 二期要加入登录退出,后台管理 下面是文档结构图 涉及的python第三方模块:flask.flask-bootstrap.sqlalchemy 整体页面的布局:页头的导航,右侧的API分类,页面信息 页面信息内容包括:接口说明,请求参数,返回参数,请求示例,返回示例 下面是定义数据库对象的mode

前后端开发过程中API接口管理有哪些痛点?附几种解决方案

一.API管理的痛点 API接口在设计时往往需要编写大量的文档,而且编写完成之后还会经常改动,文档编写维护工作量大. 接口文档编写好后,实际的代码可能会与文档有出入,这个时候文档是不准确的,文档与代码保持修改同步也是一个很大的工作量.随着接口版本的迭代,接口文档需要同步更新.有些时候接口会成为对接双方的开发进度瓶颈,因为接口调用会有依赖,类似app的项目,前端会需要调用后端接口,接口功能不实现会影响前端开发进度.接口开发完以后,做接口测试不方便,特别是接口数量多,参数复杂的情况,测试工作量大.接

如何基于 eolinker 的进行接口管理

由于工作的原因,经常要接触到很多API接口,而API接口在设计时往往需要编写大量的文档,而且编写完成后往往需要根据实际情况,经常改动文档,这使得文档编写维护工作量相对较大,这让我也包括很多的开发者都很头疼.此外,伴随着接口版本的迭代开发,接口文档也需要同步更新.而且接口开发完成以后,做接口测试会十分不方便,要是遇上接口数量多.参数负载的情况,那不仅不方便,测试工作量会重上加重.我们还经常会因为交付周期的原因,需要接入一个第三方的库,而第三方的库通常都存在文档老旧,文档不够全面等等或多或少的问题.

这个接口管理平台 eoLinker 开源版部署指南你一定不想错过

本文主要内容是讲解如何在本地部署eoLinker开源版. 环境要求 1.PHP 5.5+ / PHP7+(推荐) 2.Mysql 5.5+ / Mariadb 5.5+ 3.Nginx(推荐) / Apache 4.项目目录需要具有完全的读写权限(777),用于写入配置文件.安装完成之后可以设置另外设置目录权限 5.PHP需要安装并启用mbstring以及curl模块,用于字符串处理以及接口测试功能 注意事项 1.3.x版本与2.x版本并不兼容,因此无法直接由2.x升级到3.x,也无法通过覆盖代

部署eolinker开源版接口管理

想找一个API接口管理的软件,为了安全性和扩展性考虑,希望是开源的,而且可以在内网独立部署.网上翻找了资料,经过一份比对之后,最终采用eolinker.过去有使用过RAP,但是感觉界面实在是太丑了. 我使用的是eolinker的免费开源版(3.0的版本),官网还提供在线版,在线版的功能更加强大,但是一般来说,开源版就已经够用了,看团队的需求. eolinker官网地址:https://www.eolinker.com/#/ github上源码:https://github.com/eolinke