CSFramework.WebApi新手入门实战开发教程(C#+VS2017)


  CSFramework.WebApi新手入门实战开发教程(C#+VS2017)

CSFramework.WebApi新手入门实战开发教程(C#+VS2017)




新手入门必读:


1. 阅读《CSFramework.WebApi开发人员手册》, 了解WebApi系统功能、体系架构、接口规范等内容。

2. 调试开发环境,使用VS2015,VS2017打开CSFramework.WebApi.Foundation.sln解决方案,要能重新编译通过。.NET框架:.Net Framework 4.5

3. 附加WebApi的两个数据库。CSFramework_WebAPI,CSFramework_WebAPI_Log。

4. 修改web.config文件的connectionStrings数据库连接。

5. 将以下2个服务器之一设为启动项目。(注意:Windows服务承载方式不可进行本地调试)

6. CSFramework.WebApi开发架构:CSFramework.WebApi.Foundation.rar,基于此解决方案改名作为自己的项目。项目改名工具:http://www.csframework.com/archive/1/arc-1-20180527-2397.htm

7. C/S框架网官网搜索引擎:http://www.csframework.com/do-search.aspx


贴图图片-webapi实战开发09


贴图图片-webapi实战开发11






CSFramework.WebApi实战开发指引


一、配置ApiKey, 开发者账户


为了确保WebApi接口安全以及服务器安全,开发框架使用数据签名方式提交数据。平台必须给调用WebApi接口的客户端分配开发者账号。


打开CSFramework_WebAPI数据库的Api_UserKeys表,手工添加一条记录,如下:

贴图图片-webapi实战开发01


ApiKey:开发者账号(公钥),可以在WebApi接口传参。

SecretKey:私钥,禁止在WebApi接口传参!

EncryptKey,EncryptIV:是对称加密的密钥及偏移量,必须8位字符。



二、新建功能,命令层(Command),逻辑处理层。



贴图图片-webapi实战开发02




三、开发DAL层(数据访问层)




贴图图片-webapi实战开发03



四、客户端调试


4.1 打开CS.WebApiConsole.Tester.csproj控制台接口调试程序进行 客户端调试。


贴图图片-webapi实战开发12


4.2 使用PostMan工具调试开发好的接口

贴图图片-webapi实战开发04









五、开发框架两个核心类:


5.1 接口请求类


贴图图片-webapi实战开发06


WebApi接口请求两种常用方式:


1 ) 采用数字签名方式调用接口,必须使用ModelRequestAction类。

适用于Winform客户端、APP移动端调用、微信公众号,WebApi接口可以使用私钥签名,客户端程序必须加壳或代码混淆,然后发布给终端用户使用! 要确保私钥安全不泄露!!!


2 ) 采用Token动态令牌方式调用接口,必须使用ModelRequestToken类。

适用于Web, B/S、微信小程序、等客户端调用,不可以对接口进行私钥签名,必须使用动态token!!!! 非常重要!!!





5.2 接口响应类


贴图图片-webapi实战开发05




六、控制器命名规范


控制器必须以【具体名字】+【Controller】,
如DoController.cs  MyApiController.cs, SystemController.cs


贴图图片-webapi实战开发07




七、加载控制器所在的程序集



贴图图片-webapi实战开发10


八、自动加载Commands, 


若自定义Command在不同的程序集,调用CommandFactory.LoadCommands(typeof(CmdXXXX).Assembly)


C# Code:

Console.WriteLine("WebApiCommands:加载多个程序集的命令处理程序...");
CommandFactory.LoadCommands(
typeof(CSFramework.WebApi.Foundation.CmdBase).Assembly);

//若自定义Command在不同的程序集,调用CommandFactory.LoadCommands(typeof(xxx).Assembly)
//CommandFactory.LoadCommands(typeof(CSFramework.WebApi.XXX.CmdXXXX).Assembly);

Console.WriteLine(
"WebApiCommands:命令处理程序数目:" + CommandFactory.Commands.Count.ToString());


//来源:C/S框架网 | www.csframework.com | QQ:23404761










参考文档:


数字签名(Data Sign)+存取令牌(Access Token)双重安全请求WebApi接口

http://www.csframework.com/archive/1/arc-1-20201203-2953.htm


Web端使用VUE调用WebApi接口实现用户登录及采用Token方式数据交互

http://www.csframework.com/archive/1/arc-1-20210512-3386.htm


WebApi实例教程和使用方法:部署和发布WebApi到IIS服务器


http://www.csframework.com/archive/1/arc-1-20200223-2738.htm


原创文章:WebApi接口开发实例,搭建和部署WebApi接口

http://www.csframework.com/archive/1/arc-1-20200223-2737.htm





ASP.NET WebApi快速开发框架|APP后端框架-标准版V1.0

适用开发 适用开发:快速搭建APP、B/S、C/S、微信小程序、公众号、Web站点等后端应用服务程序。
运行平台 运行平台:Windows + .NET Framework 4.5
开发工具 开发工具:Visual Studio 2015+,C#语言
数据库 数据库:Microsoft SQLServer 2008R2+(支持多数据库:Oracle/MySql)

ASP.NET WebApi快速开发框架|MVC框架|APP微信小程序后端框架|服务端框架-标准版V1.0



CSFramework.WebApi:http://www.csframework.com/cs-framework-webapi-1.0.htm



C/S框架网|原创精神.创造价值.打造精品

扫一扫加微信
C/S框架网作者微信 C/S框架网|原创作品.质量保障.竭诚为您服务







版权声明:本文为开发框架文库发布内容,转载请附上原文出处连接
C/S框架网
上一篇:C# Winform C/S架构自动升级软件 AutoUpgrader V1.2版本
下一篇:WebApi接口请求两种常用方式:ModelRequestAction/ModelRequestToken
评论列表

发表评论

评论内容
昵称:
关联文章

CSFramework.WebApi新手入门实战开发教程(C#+VS2017)
CSFramework开发框架旗舰版V5-新手入门教程-新手指南-用户操作手册
C#.NET MVC WebApi后台开发框架入门完整版下载
WebApi实例教程和使用方法:部署和发布WebApi到IIS服务器
MiniFramework蝇量开发框架新手指南开发指南
CSFramework框架Winform项目实战案例, Winform开发的软件
CSFramework开发框架3.0解决方案改名教程
C#基础教程(上)(菜鸟教程笔记),c# 教程
使用FastReport制做报表实战-报表模块开发框架
VS2017工具箱无法加载DevExpress15.2.x控件(添加选项卡加载DLL解决)
Demo开发环境配置 - CSFramework.WebApi后端开发框架
VS发布及IIS服务器部署WebApi后台开发框架(原)
Visual Studio 2019 (C#/.NET)安装教程
VS2017打开vs解决方案提示自动升级DevExpress 17.x
CSFramework.WebApi开发框架-电商微信小程序
C# WebAPI开发平台与C# WebAPI开发框架
开发框架客户端开发教程视频|C/S框架网
VSCode配置C#运行环境教程,vscode配置c#
C/S开发框架教程:使用基础资料(数据字典)的DAL层更新主从表(或多表)数据
CSFramework.WebApiV3.VS解决方案

热门标签
.NET5 .NET6 .NET7 APP Auth-软件授权注册系统 Axios B/S B/S开发框架 Bug Bug记录 C#加密解密 C#源码 C/S CHATGPT CMS系统 CodeGenerator CSFramework.DB CSFramework.EF CSFrameworkV1学习版 CSFrameworkV2标准版 CSFrameworkV3高级版 CSFrameworkV4企业版 CSFrameworkV5旗舰版 CSFrameworkV6.0 CSFrameworkV6.1 DAL数据访问层 Database datalock DbFramework Demo教学 Demo下载 DevExpress教程 DOM EF框架 Element-UI EntityFramework ERP ES6 Excel FastReport GIT HR IDatabase IIS JavaScript LINQ MES MiniFramework MIS NavBarControl Node.JS NPM OMS ORM PaaS POS Promise API Redis SAP SEO SQL SQLConnector TMS系统 Token令牌 VS2022 VSCode VUE WCF WebApi WebApi NETCore WebApi框架 WEB开发框架 Windows服务 Winform 开发框架 Winform 开发平台 WinFramework Workflow工作流 Workflow流程引擎 版本区别 报表 踩坑日记 操作手册 代码生成器 迭代开发记录 基础资料窗体 架构设计 角色权限 开发sce 开发技巧 开发教程 开发框架 开发平台 开发指南 客户案例 快速搭站系统 快速开发平台 毛衫行业ERP 秘钥 密钥 权限设计 软件报价 软件测试报告 软件简介 软件开发框架 软件开发平台 软件开发文档 软件体系架构 软件下载 软著证书 三层架构 设计模式 生成代码 实用小技巧 收钱音箱 数据锁 数据同步 微信小程序 未解决问题 文档下载 喜鹊ERP 喜鹊软件 系统对接 详细设计说明书 新功能 行政区域数据库 需求分析 疑难杂症 蝇量级框架 蝇量框架 用户管理 用户开发手册 用户控件 在线支付 纸箱ERP 智能语音收款机 自定义窗体 自定义组件 自动升级程序