Skip to content

Latest commit

 

History

History
111 lines (94 loc) · 3 KB

http.md

File metadata and controls

111 lines (94 loc) · 3 KB

ColoryrServer

接口代码编写

返回

默认的接口代码

using ColoryrServer.SDK;

[DllIN(true)]//true则报错输出至网页
public class app_FD578CDE687FD183ED8E321C7A1ACEC25BDAF9CF
{
    [NotesSDK("一个接口", new string[1]{ "输入" }, new string[1]{ "输出" })]
    public dynamic Main(HttpDllRequest http)
    {  
        return "true";
    }
}

该代码中包含一个接口类和一个接口函数

接口类

必须带有ColoryrServer.SDK.DllIN的属性
DllIN中可以设置报错是否输出到网页中去

一个接口类必须包含名字为Main的接口函数
不是叫Main的接口函数都为识别为子接口

接口类必须是public否则将无法调用

接口类的请求地址为

http://{服务器基地址}/{UUID}

例如你的接口UUID为WebApi/test，默认配置文件的情况下，则默认的URL地址为

http://127.0.0.1/WebApi/test

接口函数

一个标准的接口函数
在接口类中，所有的public函数都为接口函数

[NotesSDK("一个接口", new string[1]{ "输入" }, new string[1]{ "输出" })]
public dynamic Main(HttpDllRequest http)
{  
    return "true";
}

接口函数输入的参数必须是ColoryrServer.SDK.HttpDllRequest
并且必须带有ColoryrServer.SDK.NotesSDK的属性

接口函数可以是static函数，使用static可以提高接口性能

子接口

一个接口类里面可以有多个子接口
子接口的请求地址为

http://{服务器基地址}/{UUID}/{name}

例如下面的代码

using ColoryrServer.SDK;

[DllIN(true)]
public class app_FD578CDE687FD183ED8E321C7A1ACEC25BDAF9CF
{
    [NotesSDK("主接口", new string[1]{ "输入" }, new string[1]{ "输出" })]
    public dynamic Main(HttpDllRequest http)
    {  
        return "true";
    }
    [NotesSDK("子接口", new string[1]{ "输入" }, new string[1]{ "输出" })]
    public dynamic push(HttpDllRequest http)
    {  
        return "ok";
    }
}

请求

http://127.0.0.1/WebApi/test

后返回的数据为

test

请求

http://127.0.0.1/WebApi/test/push

后返回的数据为

ok

接口请求参数

接口函数传入的对象为ColoryrServer.SDK.HttpDllRequest

接口返回类型

接口可以返回的类型可以是

返回其他类型会尝试进行JSON序列化