JuliaWeb/HTTP.jl

Feature: serve_file

Open

#567 创建于 2020年8月10日

在 GitHub 查看
 (4 评论) (0 反应) (0 负责人)Julia (679 star) (182 fork)batch import
enhancementhelp wantedserver

描述

This seems like generic enough functionality it could make sense to put in HTTP.jl. I don't have an api figured out, but just as a placeholder/starting point

# ?serve_file
#     serve_file(path; mimetype="infer", extension="infer", ...) :: HTTP.Response
#     serve_file(stream::HTTP.Stream, ...) :: Nothing

using HTTP

function handle_file(req::HTTP.Request)
    return HTTP.serve_file("file.txt") 
end

Some pointers to other implementations

PkgServer - https://github.com/JuliaPackaging/PkgServer.jl/blob/065235d39b4f66018dbc51ce3cb6861429f095e2/src/resource.jl#L394

Genie - https://github.com/GenieFramework/Genie.jl/blob/899ea32d3a7a95aab3bfe508fc9d6821bde2a1e0/src/Router.jl#L992

Flask - https://github.com/pallets/flask/blob/632f85b65354ad573bb33c54a0a9dd3ffcef371f/src/flask/helpers.py#L447

贡献者指南

技术栈
无
领域
backend
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
over 1 week
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
unclear
前置要求
basic Julia knowledgeunderstanding of HTTP.jl
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
25
研究方向
Review the linked implementations (PkgServer.jl, Genie.jl, Flask) for reference on serving files. Investigate the HTTP.jl source to understand how to integrate a serve file function, looking at existing handlers and the response type. Check the issue comments for any further discussion on desired API.