Swagger 是一個用于設計、構建、記錄和使用 RESTful Web 服務的框架。在 Ubuntu 系統中,你可以使用 Swagger UI 來展示和測試你的 API。當你的 API 返回錯誤響應時,Swagger UI 會以一種易于理解的方式展示這些錯誤。
要處理錯誤響應,你需要在你的 API 中定義適當的 HTTP 狀態碼和錯誤消息。這通常是在你的后端代碼中完成的。以下是一些關于如何在不同的后端框架中處理錯誤響應的示例:
app.use(function (err, req, res, next) {
console.error(err.stack);
res.status(500).json({ error: 'Internal Server Error' });
});
from django.http import JsonResponse
def my_view(request):
try:
# Your code here
except Exception as e:
return JsonResponse({'error': 'Internal Server Error'}, status=500)
@app.errorhandler(500)
def internal_server_error(error):
return jsonify(error='Internal Server Error'), 500
一旦你在后端代碼中定義了錯誤響應,Swagger UI 將自動捕獲這些錯誤并以一種易于理解的方式展示它們。你可以在 Swagger UI 的 “Responses” 部分查看每個 API 端點的預期錯誤響應。
如果你想要自定義 Swagger UI 中錯誤響應的顯示方式,你可以通過修改 Swagger UI 的源代碼或使用自定義 CSS 和 JavaScript 來實現。具體方法取決于你使用的 Swagger UI 版本和配置。