API接口开发

flashman

我有一个内网的MySql数据库，另外有一台服务器有公网IP，我要怎样才能做到开发API接口？

比如最简单的get方式查询某个数据库表数据。

admin

如果真的想做webapi的话，我还是推荐使用传统的后端解决方案的。比如微软的.net 8。有现成的框架使用，开发也很简单的。只是没有基础的人会很害怕，没有方向，不知道如何开始。

我的平台里面也提供了一个简单的开发webapi的模块。HttpServer
我大概介绍一下使用方法，主要分三个阶段：开发阶段、运行阶段、使用对接阶段

一、开发阶段
你需要根据业务需求创建相应的webapi接口。

1、点击主菜单中的HttpServer模块菜单，打开“HttpServer事件管理”窗口。
介绍：左边是我们管理API接口的目录树表，可以让我们以目录树的形式管理我们的webapi接口。并且编写相应的代码。右边是我们连接“运行阶段”服务器端的设置，主要目的是可以实现动态地将我们本地开发的API接口同步到远程服务器端，而不需要修改一点东西就要重新打包重新发布。

2、编写webapi接口。
路径：我们在路径里面定义webapi的访问路径地址，这个路径必须唯一不重复。路径必须以“/”开头。
用户代码：我们直接在相应的路径行编写相应的webapi接口。

下面就是一个webapi接口的示例，主要实现将一个表以Json的形式返回。

Dim e As SmHttpRequestEventArgs=Args(0)
'e.SendString("森之格平台")
Dim dt As DataTableHelp=Proj.SysDataFactory("UserDB").ExecuteDataTableHelp("select * From EmployeeInfo")
e.SendString(dt.ToJson())
复制代码

3、写一个菜单，可以执行下面的代码

Dim frm As New HttpServerManager
frm.Show()
复制代码

二、运行阶段
我们将软件发布，然后在一个拥有外网IP的服务器上运行。

填写一个端口，比如5001，然后点击启动按钮。

说明：设置远程编程按钮是用来与开发阶段第一步右边那个同步开发端代码配合的功能，可以接受开发阶段客户端的命令，同步代码、更新接口。

三、使用对接阶段
根据你的使用场景，在浏览器里面输入webapi接口路径：http://127.0.0.1:5001/main/test

这时我们就会看到相应的返回结果了。

关于Webapi接口代码编写：
这里先做简要的说明，详细的会单独做一个帮助文档。我们可以把每个webapi接口都当作是一个内部函数，函数名就是路径，而我们管理的函数名是方便我们自己清楚明白的名称。函数输入的参数是SmHttpRequestEventArgs，我们可以通过代码编辑器的右键“显示定义”菜单，查看支持的属性与方法。