金蝶云星空插件实战开发-新手入门教程-自定义WebAPI-1
发布网友
发布时间：2024-09-15 02:20
共1个回答
热心网友
时间：2024-10-05 16:48
本文面向云星空二次开发新手，旨在阐述如何使用Postman模拟第三方系统更新采购订单的全过程。开发环境包括Visual Studio 2019，开发语言为C#，星空版本为7.6.0，插件类型为自定义WebAPI。
首先，确认开发机已安装金蝶云星空系统和金蝶BOS IDE。推荐阅读金蝶云星空二次开发-知识地图、金蝶云星空插件实战开发-新手入门教程-表单插件、金蝶云星空插件实战开发-新手入门教程-列表插件、金蝶云星空插件实战开发-新手入门教程-服务插件等文章以获取背景知识。本教程的完整代码请访问文章末尾的链接。
星空系统集成包括WebAPI、WebService、ClientProxy三种方式。集成意味着与第三方系统的数据对接。WebAPI常用接口有：登录验证、查看单据、保存单据、批量保存、提交单据、审核单据、反审核单据、删除单据、单据数据查询、暂存单据、分配表单数据、下推、分组保存等。
使用WebAPI的一般步骤包括登录、构建和传递Model数据包。WebAPI模拟录单过程，依据传入的JSON数据包构造字段值，按顺序填充字段，触发相关事件、实体服务和插件逻辑。构造完成后调用Save、Submit、Audit，触发操作校验、逻辑和单据插件逻辑。
录入顺序需遵循系统字段列表属性顺序，否则存在覆盖值问题。MVC结构研发者应熟悉.Net框架基础结构，通过基础管道中的HttpApplication和HttpContext处理请求。星空的自定义WebAPI继承KDBaseService，请求路径为xxx.common.kdsvc，通过反射执行操作。
开发流程如下：
1. 创建Visual C#类库。
2. 引用星空系统类库。
3. 编写自定义WebAPI。
4. 编译生成dll文件。
5. 部署。
6. 重启IIS服务。
7. 使用Postman模拟请求。
创建Visual C#类库后，引入星空系统类库，编写自定义WebAPI。代码包括BusinessService.cs、Defineds.cs、Checker.cs、Formater.cs、BillHandler.cs等文件，分别负责程序逻辑、参数定义、参数检查、格式化和单据操作。使用“BusinessService.cs”作为程序入口，定义保存、提交和审核的WebAPI方法。
在Defineds.cs文件中定义常量和参数结构，包括保存、提交、审核的WebAPI动作参数和客户端请求参数、处理结果结构。获取单据的FormId通常从官方文档或BOS中查找。具体实现中，需要使用获取的FormId和明细属性Key进行参数校验。
Checker.cs文件用于客户端参数的校验，确保参数符合WebAPI要求。在实际项目中，需对参数进行严格校验。本教程作为入门指导，参数校验较为简单。
本教程分为两部分，此为第一部分。第二部分将深入探讨更复杂的自定义WebAPI开发。完成作业的读者可留言交流，遇到问题亦可提问。教程同步发布于“代码乾坤”公众号和gitee代码库。
