Webframework

webframework是一个有趣的Rust Web应用框架。其主要目标是：安全性、有趣、速度。它试图通过约定、derive宏和cli工具的组合来实现这些目标。

要查看完整示例，请查看待办事项示例。

如果您需要文档，请在此处找到：TODO

完整文档可在此处找到：文档

功能

• 异步
• 易于使用

更多功能将陆续推出！ 该项目正在积极开发中。请随时加入并帮助扩展该框架。

示例

您可以在文档中找到示例。

结构

webframework项目由不同的crate组成

• webframework：主crate，也是最终用户需要导入的唯一crate。它重新导出所有需要的内部类型，并导出一个用户可以使用的预言。
• webframework-core：内部crate之一，在这里定义了项目的基类型。这主要对项目本身的开发者和想要与这些定义接口的附加crate的开发者有用。
• webframework-derive：主要derive宏从这里导出。在这里定义了便捷的宏。

将来肯定会出现新的crate，但webframework始终应该是连接一切的那个。

贡献

任何人都可以为webframework项目做出贡献，无论是编写功能、添加测试还是编写文档。报告错误或寻求帮助也受到鼓励。但请记住，这是一个社区项目，这意味着您遇到的每个人都是在业余时间做的。因此，请确保保持尊重并忍受可能较长的回复时间。

贡献代码

代码贡献是添加新功能的最受欢迎方式。如果您需要某个功能，并且能够将其添加到仓库中，请随时提交一个新的pull请求或问题。如果您需要帮助，我们将尽力引导或指导您如何完成。

贡献测试

测试非常重要。它们使我们能够确定功能是否按预期工作，以及在更改之后没有出现损坏。这就是为什么总是欢迎添加新的测试。这可以是从简单的小单元测试到整个集成测试。如果您不确定可以测试什么，可以编写文档测试！只需选择任何没有测试的方法或类型，并为它编写一个示例，演示它有什么效果。如果您需要帮助，我们会引导您。

编写文档

文档使任何人都能学习或审查如何使用此框架。因此，拥有大量正确的文档非常重要。因此，如果您注意到任何错别字、遗漏或其他不明确的文档，请提出问题，或者更好的是，提交一个pull请求来修复它。如果您想写更多内容，指南或博客文章也很受欢迎。

仓库规范

所有新功能都应该通过bors合并的pull请求进入master分支。这使我们能够始终保持master分支的构建状态。

Git提交消息应该使用祈使句形式，但这不是硬性规定。然而，所有提交消息都必须按照以下格式正确格式化

<type ofchange>(<changed system>): <description>

允许的类型有：feat、fix、chore、test、refactor、style、docs

以下是一些示例

• feat(webframework):添加新的Frobnarizer组件
• chore(webframework-core):将变量重命名以保持一致性在Frobnarizer#foo

Licence

项目 webframework 在MIT许可下。