快嘉接口定义指南

最新推荐文章于 2024-07-12 16:16:27 发布
最新推荐文章于 2024-07-12 16:16:27 发布
阅读量92 收藏
点赞数
文章标签： python json
原文链接：https://my.oschina.net/fastjrun/blog/1784695
版权

2019独角兽企业重金招聘Python工程师标准>>> hot3.png

快嘉代码生成能力平台目前一共提供了三种接口的代码生成模板，分别是apiControllers、appControllers和genericControllers，其中apiControllers和appControllers为封装好的接口类型，可以分别作为开放平台接口选型和移动端接口选型，genericControllers比较灵活，可以适应绝大部分接口场景。

下面就以genericControllers为例介绍如何设计接口。

请求body为空默认响应

<bundle>
	<packets>
	</packets>
	<genericControllers>
		<genericController name="AppVersionGenericController"
			version="" path="/generic/version/" clientName="AppVersionGenericClient"
			clientParent="com.fastjrun.client.BaseGenericClient" remark="版本接口"
			tags="基本接口">
			<service name="versionService" class="VersionServiceRestGeneric">
				<method name="latests" version="" path="latests" remark="最近版本列表">
				</method>
			</service>
		</genericController>
	</genericControllers>
</bundle>

以上接口访问路径、请求参数、示例和响应参数、示例如下 输入图片说明

请求body有值默认响应

<bundle>
    <packets>
        <packet class="packet.generic.RegistserRestRequestBody" parent="com.fastjrun.packet.BaseRequestBody">
            <field name="loginId" dataType="String" length="12" canBeNull="false"
            remark="登录名" />
        </packet>
    </packets>
    <genericControllers>
        <genericController name="AppVersionGenericController"
        version="" path="/generic/version/" clientName="AppVersionGenericClient"
        clientParent="com.fastjrun.client.BaseGenericClient" remark="版本接口"
        tags="基本接口">
            <service name="versionService" class="VersionServiceRestGeneric">
                <method name="latests" version="" path="latests" remark="最近版本列表">
                    <request class="packet.generic.RegistserRestRequestBody" />
                </method>
            </service>
        </genericController>
    </genericControllers>
</bundle>

如上所示，请求参数定义为packet，class为类名，该packet只有一个参数loginId，类型为String，长度12，不可为空，备注为登录名。 该请求参数在接口系统中示例 输入图片说明 以上接口访问路径、请求参数、示例和响应参数、示例如下 输入图片说明

响应有值，且响应报文中如何定义list

<bundle>
    <packets>
        <packet class="packet.generic.RegistserRestRequestBody" parent="com.fastjrun.packet.BaseRequestBody">
            <field name="loginId" dataType="String" length="12" canBeNull="false"
            remark="登录名" />
        </packet>
        <packet class="packet.generic.VersionListResponseBody" parent="com.fastjrun.packet.BaseResponseBody">
            <list name="list" class="packet.generic.Version">
                <field name="id" dataType="Long" length="64" canBeNull="false"
                remark="版本Id" />
                <field name="versionNo" dataType="String" length="64"
                canBeNull="false" remark="版本号" />
                <field name="versionInfo" dataType="String" length="400"
                canBeNull="false" remark="版本信息" />
            </list>
        </packet>
    </packets>
    <genericControllers>
        <genericController name="AppVersionGenericController"
        version="" path="/generic/version/" clientName="AppVersionGenericClient"
        clientParent="com.fastjrun.client.BaseGenericClient" remark="版本接口"
        tags="基本接口">
            <service name="versionService" class="VersionServiceRestGeneric">
                <method name="latests" version="" path="latests" remark="最近版本列表">
                    <request class="packet.generic.RegistserRestRequestBody" />
                    <response class="packet.generic.VersionListResponseBody" />
                </method>
            </service>
        </genericController>
    </genericControllers>
</bundle>

如上所示，VersionListResponseBody中增加list节点，name为键值，class为list中存储对象类名。 VersionListResponseBody在接口系统中示例

输入图片说明

以上接口访问路径、请求参数、示例和响应参数、示例如下 输入图片说明 如图中所示，list对应json结构为数组。

备注 ：genericController没有响应body时，系统会提供默认响应；如果设置了响应body，则以响应body为返回值。

请求有值，且请求报文中如何增加object

<?xml version="1.0" encoding="UTF-8"?>
<bundle>
    <packets>
        <packet class="packet.generic.RegistserRestRequestBody" parent="com.fastjrun.packet.BaseRequestBody">
            <field name="loginId" dataType="String" length="12" canBeNull="false"
            remark="登录名" />
            <object name="obj" class="packet.generic.RegistserRestRequestBodyObj">
                <field name="id" dataType="Long" length="64" canBeNull="false"
                remark="版本Id" />
            </object>
        </packet>
        <packet class="packet.generic.VersionListResponseBody" parent="com.fastjrun.packet.BaseResponseBody">
            <list name="list" class="packet.generic.Version">
                <field name="id" dataType="Long" length="64" canBeNull="false"
                remark="版本Id" />
                <field name="versionNo" dataType="String" length="64"
                canBeNull="false" remark="版本号" />
                <field name="versionInfo" dataType="String" length="400"
                canBeNull="false" remark="版本信息" />
            </list>
        </packet>
    </packets>
    <genericControllers>
        <genericController name="AppVersionGenericController"
        version="" path="/generic/version/" clientName="AppVersionGenericClient"
        clientParent="com.fastjrun.client.BaseGenericClient" remark="版本接口"
        tags="基本接口">
            <service name="versionService" class="VersionServiceRestGeneric">
                <method name="latests" version="" path="latests" remark="最近版本列表">
                    <request class="packet.generic.RegistserRestRequestBody" />
                    <response class="packet.generic.VersionListResponseBody" />
                </method>
            </service>
        </genericController>
    </genericControllers>
</bundle>

如上所示，RegistserRestRequestBody中增加object节点，name为键值，class为对应类名。 RegistserRestRequestBody在接口系统中示例 输入图片说明

请求路径中增加pathParam

<bundle>
    <packets></packets>
    <genericControllers>
        <genericController name="AppVersionGenericController"
        version="" path="/generic/version/" clientName="AppVersionGenericClient"
        clientParent="com.fastjrun.client.BaseGenericClient" remark="版本接口"
        tags="基本接口">
            <service name="versionService" class="VersionServiceRestGeneric">
                <method name="latests" version="" path="latests" remark="最近版本列表">
                    <pathvariables>
                        <pathvariable name="appKey" dataType="String" length="32"
                        remark="分配客户端key" />
                        <pathVariable name="accessTime" dataType="Long"
                        length="11" remark="访问时间戳" />
                    </pathvariables>
                </method>
            </service>
        </genericController>
    </genericControllers>
</bundle>

如上所示，method节点下增加pathvariables节点，pathvariables节点下设置pathvariable节点，pathvariable按接口文档中定义顺序排列在url中。

以上接口访问路径、请求参数、示例和响应参数、示例如下

输入图片说明

请求路径中增加queryParam

<bundle>
    <packets></packets>
    <genericControllers>
        <genericController name="AppVersionGenericController"
        version="" path="/generic/version/" clientName="AppVersionGenericClient"
        clientParent="com.fastjrun.client.BaseGenericClient" remark="版本接口"
        tags="基本接口">
            <service name="versionService" class="VersionServiceRestGeneric">
                <method name="latests" version="" path="latests" remark="最近版本列表">
                    <parameters>
                        <parameter name="pageNum" dataType="Integer" length="11"
                        canBeNull="true" remark="每页返回多少条记录" />
                        <parameter name="pageIndex" dataType="Integer" length="11"
                        canBeNull="true" remark="页索引" />
                    </parameters>
                </method>
            </service>
        </genericController>
    </genericControllers>
</bundle>

如上所示，method节点下增加parameters节点，parameters节点下设置parameter节点。

以上接口访问路径、请求参数、示例和响应参数、示例如下 输入图片说明

请求头中增加headerParam

<bundle>
    <packets></packets>
    <genericControllers>
        <genericController name="AppVersionGenericController"
        version="" path="/generic/version/" clientName="AppVersionGenericClient"
        clientParent="com.fastjrun.client.BaseGenericClient" remark="版本接口"
        tags="基本接口">
            <service name="versionService" class="VersionServiceRestGeneric">
                <method name="latests" version="" path="latests" remark="最近版本列表">
                    <headvariables>
                        <headvariable name="salt" dataType="String" length="8"
                        remark="加密盐值" />
                        <headvariable name="sign" dataType="String" length="32"
                        remark="签名" />
                    </headvariables>	
                </method>
            </service>
        </genericController>
    </genericControllers>
</bundle>

如上所示，method节点下增加headvariables节点，headvariables节点下设置headvariable节点。

以上接口访问路径、请求参数、示例和响应参数、示例如下 输入图片说明

其它（略）

还有一些其它示例罗列下，读者可自行试验。

  • 报文list节点中嵌套list
  • 报文list节点中含object
  • 报文object节点中嵌套object
  • 报文object节点中含list

转载于:https://my.oschina.net/fastjrun/blog/1784695

weixin_34088583
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
RJ45接口定义和连接.pdf
11-19
网口定义及连接
SFP光模块电气接口定义.pdf
04-26
SFP光模块电气接口定义.pdf
快嘉框架使用指南
weixin_34268753的博客
03-12 81
2019独角兽企业重金招聘Python工程师标准>>> ...
使用快嘉sdkg极速搭建接口模拟系统
weixin_34203426的博客
06-21 100
2019独角兽企业重金招聘Python工程师标准>>> ...
快嘉框架 v2.0 更新发布，J2EE 开发框架实例
weixin_34392435的博客
03-10 70
开发四年只会写业务代码，分布式高并发都不会还做程序员？ >>> 快嘉框架是一个面向变化的J2EE开发...
LTE入门指南（物理层）PHY
MasterLiu的博客
05-08 7717
LTE入门指南（物理层） 原博地址：点击打开链接     网上有很多LTE的书籍文档，我开始也下了一堆，后面就搞不清楚该看哪些了。 经过几个月的梳理，个人感觉有一条比较适合自己的方法来入门，与大家分享，不一定适合亲哦！     如果大家有问题可以一起交流，我是一只菜鸟！ 一 LTE 协议    下载网址：http://www.3gpp.org/DynaReport/
常见电台手咪接口定义.pdf
01-09
常见手咪接口定义
p328GP338 接口定义
06-19
Gp328 GP338 接口定义 可以了解各个接口的用途
API数据服务接口开发指南.docx
07-13
本指南详细阐述了API数据服务接口的开发标准，包括接口定义、数据结构、通信协议以及错误处理策略，为开发者提供了全面的参考，以实现高效、安全的接口开发和集成。在实际开发过程中，开发者应严格按照指南执行，以...
cv2读取和保存图片
最新发布
m0_53291740的博客
07-12 110
cv2.imwrite('b\\img1.png',img)#b存在就可以保存进去。如果b存在，c不存在，程序不会报错，也不会保存图片。如果目录b不存在就会存到当前文件夹。
面试题 21：解释 Python 中的 help() 函数和 dir() 函数？
专注于全栈开发领域
07-10 748
在Python中，help()和dir()是两个非常有用的内置函数，它们可以帮助开发者更好地了解Python对象和模块。
聊聊如何在内网下构建大模型微调环境
python1234567_的博客
07-12 672
LlamaFactory新版更新后，还是比较方便，只是说llamafactory-cli命令的确是有点蒙，踩个坑就好了。对于LlamaFactory微调来说，本身不难，毕竟都是配置；主要是在内网环境下的依赖包拉取安装是真麻烦，但其实也还好。走一遍的话，还是可以学到很多的。​。
已解决 javax.xml.transform.TransformerFactoryConfigurationError 异常的正确解决方法，亲测有效！！！
小明的Java问道之路
07-08 2369
已解决 javax.xml.transform.TransformerFactoryConfigurationError 异常的正确解决方法，亲测有效！！！
leetcode--验证二叉搜索树
liulanba的博客
07-09 657
给你一个二叉树的根节点 root ，判断其是否是一个有效的二叉搜索树。有效 二叉搜索树定义如下：节点的左子树只包含 小于 当前节点的数。节点的右子树只包含 大于 当前节点的数。所有左子树和右子树自身必须也是二叉搜索树。示例 1：输入：root = [2,1,3]输出：true示例 2：输入：root = [5,1,4,null,null,3,6]输出：false解释：根节点的值是 5 ，但是右子节点的值是 4。提示：树中节点数目范围在[1, 104] 内。
java占位符替换五种方式
weixin_61478518的博客
07-08 564
在业务开发中，经常需要输出文本串。其中，部分场景下大部分文本内容是一样的，只有少部分点是不一样。简单做法是直接拼接字段，但是这会有个问题。后面如果想要修改内容，那么每个地方都要修改，这不符合设计模式中的开闭原则，面向应该对扩展开放，对修改关闭。如何解决这个问题？先来看现实生活中的例子，个人信息填写。一般会要填写表格，已经定义好了姓名，性别，年龄等字段，只要填写对应的个人信息就好了。在程序开发中，我们会预先定义好一个字符串模板，需要改动的点使用占位符。
一键安装ros及出现问题的解决方案
m0_58173801的博客
07-10 558
catkin_make时出现报错如下。
【python学习】闭包的定义与特点，以及一些常用场景的使用
m0_49243785的博客
07-11 1015
闭包是一个函数，闭包让你可以在一个内层函数中访问其外层函数的作用域，可以使用闭包进行模块化代码和封装代码的操作，从而提高效率。
Java进阶篇之Fork/Join 框架：并行处理的艺术
小码农的博客
07-09 680
在多核时代，如何有效利用多核处理器的并行计算能力成为了软件开发中的重要议题。Java 7引入的Fork/Join框架正是为此目的而生，它提供了一套高度优化的并行任务分解和合并机制，极大地简化了并行编程的复杂度，同时提升了应用程序的性能。本文将全面剖析Fork/Join框架的原理、使用方法及最佳实践。Fork/Join框架的核心在于将一个大任务分解（Fork）成多个较小的子任务，并行执行这些子任务，然后将子任务的结果合并（Join）起来形成最终结果。
API接口设计项目说明指导书.docx
11-24
"《XXAPI接口设计说明书》是一份详细的项目指南，旨在为企业提供API接口设计的标准化流程和规范。该文档于11月25日发布，适用于所有参与该项目的开发团队、管理员以及用户。编写目标明确，主要是为了帮助读者理解和...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值