我不仅要返回JSON，还要返回HTTP响应代码。
我通过URLRouter注册REST接口：
router.registerRestInterface(new ClientServerAPI);
我的 REST 实现示例：
module clienserverapi.clientserver;
import api.clientserver;
import models.replies.client_versions;
/**
Implementation of Client-Server API.
*/
class ClientServerAPI : IClientServerAPI {
@safe:
ClientVersions getSupportedClientVersions() {
bool[string] unstableFeatures;
return ClientVersions(supportedVersions.dup, unstableFeatures);
}
}
在 REST接口生成器中，响应代码是自动处理的，并且由于您无法将 HTTPServerResponse/HTTPServerRequest 参数传递到 REST 方法中，因此您无法控制返回什么状态。
但是，有一些内置状态需要处理：
- 根据内容返回 200/204
- 400 参数不匹配的错误请求
- 404 找不到不匹配的路线
- 大多数异常时返回 500 内部服务器错误
- (在调试模式之外)发送未授权/错误请求/禁止发送
另请参阅：REST 接口文档
您可以使用HTTPStatusException控制任何状态代码，但是它被视为错误，并将导致预定义的错误json，该错误将statusMessage设置为异常消息并返回您传递给它的HTTP状态代码。(这可能是您想要的错误处理)
您还可以通过在 RestInterfaceSettings 中将 errorHandler 设置为 RestErrorHandler 委托来更改错误的外观。
或者，根据你想做什么，你可以使用一个 WebInterface，它很像一个 rest 接口，但没有一些方便的函数 REST 接口，而是可以完全访问请求/响应参数，基本上可以做任何像普通 http 路由一样的事情，并有一些其他你可以使用的便利函数。
从理论上讲，如果您想返回带有数据的自定义成功代码，您可以使用有效的 HTTP 状态代码滥用 errorHandler + HTTPStatusException，但我会不鼓励这样做，而是使用 Web 界面，如果这是您所追求的。
但是，如果您只想使用自定义但一致的错误页面的自定义错误代码，那么我肯定会使用带有 errorHandler 的 REST 接口。
您现在可以看起来像这样：
import vibe.vibe;
import std.uni;
@safe:
void main() {
auto server = new HTTPServerSettings;
server.port = 3000;
server.bindAddresses = ["::1", "127.0.0.1"];
auto router = new URLRouter;
RestInterfaceSettings settings = new RestInterfaceSettings();
// this is how the error page will look on any thrown exception (like HTTPStatusException)
settings.errorHandler = (HTTPServerRequest req, HTTPServerResponse res,
RestErrorInformation error) @safe {
res.writeJsonBody([
// design this however you like
"ok": Json(false),
"error": serializeToJson([
"status": Json(cast(int)error.statusCode),
"message": Json(error.exception.msg),
"parent": Json("/api/something")
])
]);
};
router.registerRestInterface(new Impl, settings);
listenHTTP(server, router);
runApplication();
}
interface RestAPI {
string getGreeting(string name);
}
class Impl : RestAPI {
string getGreeting(string name)
{
// throw an HTTP Bad Request error when name is empty
if (name.length == 0)
throw new HTTPStatusException(HTTPStatus.badRequest, "Name parameter cannot be empty!");
// throw an HTTP Conflict error code when name is Bob
if (sicmp(name, "bob") == 0)
throw new HTTPStatusException(HTTPStatus.conflict, "Server cannot greet Bob!");
return "Hello, " ~ name ~ "!";
}
}
然后你的服务器将响应如下内容：
{
"ok": false,
"error": {
"message": "Server cannot greet Bob!",
"status": 409,
"parent": "/api/something"
}
}
您可以尝试 hunt 框架，这是 Rest API 的示例代码：
module app.controller.myapi;
import hunt.framework;
import app.message.UserMessage;
class MyapiController : Controller
{
mixin MakeController;
@Action
JsonResponse test()
{
UserMessage user;
user.id = 1;
user.name = "MyName";
user.email = "test@domain.com";
return new JsonResponse(user);
}
}
您的响应结构：
module app.message.ResultMessage;
struct UserMessage
{
int id;
string name;
string email;
}
响应结果为：
[ "id": 1, "name": "MyName", "email": "test@domain.com" ]