跳至内容

帮助 FastAPI - 获取帮助

你喜欢 FastAPI 吗？

你想帮助 FastAPI、其他用户和作者吗？

或者你想要得到关于 FastAPI 的帮助吗？

有很多简单的方法可以帮助（其中一些只需点击一两次）。

还有很多方法可以获得帮助。

订阅通讯

你可以订阅（不经常发布的）FastAPI 和朋友们 通讯 以了解以下信息：

  • 关于 FastAPI 和朋友们的新闻 🚀
  • 指南 📝
  • 功能 ✨
  • 重大更改 🚨
  • 提示和技巧 ✅

关注 FastAPI 的 Twitter

关注 @fastapi 在 Twitter 上 以获取 FastAPI 的最新消息。 🐦

在 GitHub 上为 FastAPI 加星

你可以在 GitHub 上为 FastAPI “加星”（点击右上角的星形按钮）：https://github.com/fastapi/fastapi. ⭐️

通过添加星标，其他用户将能够更容易地找到它，并看到它对其他人已经很有用。

关注 GitHub 仓库以获取发布信息

你可以在 GitHub 上“关注” FastAPI（点击右上角的“关注”按钮）：https://github.com/fastapi/fastapi. 👀

在那里你可以选择“仅限发布”。

通过这样做，你将收到通知（在你的电子邮件中），只要有新的发布（新版本）的 FastAPI，其中包含错误修复和新功能。

联系作者

你可以联系我（Sebastián Ramírez / tiangolo），作者。

你可以

  • 关注我的 GitHub.
    • 查看我创建的其他开源项目，它们可能对你有所帮助。
    • 关注我，看看我什么时候创建了新的开源项目。
  • 关注我在 Twitter 上 或 Mastodon.
    • 告诉我你如何使用 FastAPI（我喜欢听到这些）。
    • 听到我发布公告或发布新工具时。
    • 你也可以关注 @fastapi 在 Twitter 上（一个单独的帐户）。
  • 关注我的 LinkedIn.
    • 听到我发布公告或发布新工具时（虽然我更常使用 Twitter 🤷‍♂）。
  • 阅读我在 Dev.to 或 Medium 上写的文章（或关注我）。
    • 阅读其他想法、文章，以及关于我创建的工具的信息。
    • 关注我，以便在我发布新内容时阅读。

关于 FastAPI 的推文

关于 FastAPI 的推文 并让我和其他用户知道你为什么喜欢它。 🎉

我很乐意听到大家是如何使用 **FastAPI** 的，你对它喜欢哪些方面，你在哪些项目/公司中使用它等等。

为 FastAPI 投票

在 GitHub 上帮助他人解答问题

你可以尝试帮助他人解答他们遇到的问题，在

很多情况下你可能已经知道这些问题的答案。🤓

如果你经常帮助别人解答问题，你将成为一名官方的 FastAPI 专家。🎉

请记住，最重要的点是：要友善。人们会带着自己的沮丧来提问，很多情况下他们的提问方式并不完美，但请尽你所能保持友善。🤗

**FastAPI** 社区的理念是友善和欢迎。同时，不要接受对他人进行欺凌或不尊重的行为。我们必须互相照顾。

以下是如何帮助他人解答问题（在 discussions 或 issues 中）：

理解问题

  • 首先要确定你是否能理解提问者的 **目的** 和使用场景。

  • 然后，检查问题（绝大多数是问题）是否 **清晰**。

  • 很多情况下，提问者提出的问题是基于他们自己想象的解决方案，但可能存在 **更好的** 解决方案。如果你能更好地理解问题和使用场景，你就可以提出更好的 **替代方案**。

  • 如果你不理解问题，请要求提供更多 **细节**。

复现问题

对于大多数情况和大多数问题，都与提问者的 **原始代码** 有关。

很多情况下，他们只会复制一段代码片段，但这不足以 **复现问题**。

  • 你可以要求他们提供一个 最小、可复现的示例，这样你就可以 **复制粘贴** 并本地运行，以查看他们遇到的相同错误或行为，或者更好地理解他们的使用场景。

  • 如果你心情特别好，可以尝试 **自己创建一个** 这样的示例，仅基于对问题的描述。但请记住，这可能需要很多时间，最好先要求他们澄清问题。

提出解决方案

  • 在理解问题后，你可以给出一个可能的 **答案**。

  • 很多情况下，最好理解他们 **背后的问题或使用场景**，因为可能存在比他们正在尝试做的更好的解决方法。

请求关闭

如果他们回复了，很有可能你已经解决了他们的问题，恭喜你，**你是英雄**！🦸

  • 现在，如果问题已解决，你可以要求他们：

    • 在 GitHub Discussions 中：将你的评论标记为 **答案**。
    • 在 GitHub Issues 中：**关闭** 问题。

关注 GitHub 仓库

你可以在 GitHub 上“关注” FastAPI（点击右上角的“关注”按钮）：https://github.com/fastapi/fastapi. 👀

如果你选择 "Watching" 而不是 "Releases only"，你将在有人创建新的 issue 或问题时收到通知。你还可以指定你只希望收到关于新 issue、讨论、PR 等等的通知。

然后，你可以尝试帮助他们解决这些问题。

提问

你可以在 GitHub 仓库中 创建新的问题，例如：

  • 提出 **问题** 或询问 **问题**。
  • 建议新的 **功能**。

**注意**：如果你这样做，我会要求你也帮助他人。😉

审查 Pull Requests

你可以帮助我审查他人提交的 pull requests。

再次强调，请尽你所能保持友善。🤗

以下是一些需要注意的点以及如何审查 pull request：

理解问题

  • 首先，确保你 **理解** pull request 要解决的问题。它可能在 GitHub Discussion 或 issue 中有更长的讨论。

  • 还有很大可能，pull request 实际上并不需要，因为问题可以通过 **其他方式** 解决。然后，你可以提出建议或询问关于其他解决方法。

不用担心风格

  • 不要太在意 commit 信息的风格，我会手动压缩合并并自定义 commit 信息。

  • 同样，也不要担心代码风格规则，已经有自动化的工具在检查这些问题。

如果还有其他风格或一致性方面的问题，我会直接提出要求，或者我会在上面添加必要的更改。

检查代码

  • 检查并阅读代码，看看是否有意义，**在本地运行** 并看看它是否真正解决了问题。

  • 然后 **评论** 说你做了这些，这样我就知道你真的检查了。🤓

信息

不幸的是，我不能简单地信任那些只有几个审批的 PR。

很多时候，我遇到过有 3、5 个或更多审批的 PR，可能是因为描述很吸引人，但当我检查这些 PR 时，实际上它们是有问题的，存在 bug，或者没有解决它们声称要解决的问题。😅

因此，你真正阅读并运行代码，并在评论中告诉我你做了这些非常重要。🤓

  • 如果 PR 可以简化，你可以提出要求，但不需要太挑剔，可能会有很多主观的观点（我也会有自己的观点🙈），所以如果你能专注于根本问题，那就更好了。

测试

  • 帮助我检查 PR 是否有 **测试**。

  • 检查测试在 PR 之前是否 **失败**。🚨

  • 然后检查测试在 PR 之后是否 **通过**。✅

  • 很多 PR 并没有测试，你可以 **提醒** 他们添加测试，或者你甚至可以 **自己建议** 一些测试。这是最耗时的工作之一，而你可以在这方面提供很大的帮助。

  • 然后，也评论你尝试了什么，这样我就知道你检查过了。🤓

创建 Pull Request

你可以通过 Pull Request 贡献 源代码，例如：

  • 修复你在文档中发现的错别字。
  • 通过 编辑此文件，分享你创建或发现的关于 FastAPI 的文章、视频或播客。
    • 确保将你的链接添加到相应部分的开头。
  • 帮助 将文档翻译 成你的语言。
    • 你也可以帮助审查他人创建的翻译。
  • 建议新的文档部分。
  • 修复现有的问题/bug。
    • 确保添加测试。
  • 添加新的功能。
    • 确保添加测试。
    • 如果相关，确保添加文档。

帮助维护 FastAPI

帮助我维护 **FastAPI**！🤓

有很多工作要做，而且其中大多数工作 **你** 可以做。

你现在可以做的主要任务是：

这两个任务 **最耗时**。这是维护 FastAPI 的主要工作。

如果你能帮助我做这些事情，**你就是在帮助我维护 FastAPI**，并确保它继续 **更快、更好地发展**。🚀

加入聊天

加入 👥 Discord 聊天服务器 👥 并与 FastAPI 社区的其他人一起交流。

提示

对于问题，请在 GitHub Discussions 中提出，你更有可能得到 FastAPI 专家 的帮助。

只在聊天中进行其他一般性对话。

不要在聊天中提问

请记住，由于聊天允许更 "自由的对话"，很容易提出过于笼统的问题，而这些问题更难回答，所以你可能无法得到答案。

在 GitHub 上，模板会引导你编写正确的问题，这样你就可以更容易地得到一个好的答案，甚至在提问之前就解决问题。在 GitHub 上，我可以确保我始终回答所有问题，即使这需要一些时间。我无法在聊天系统中做到这一点。😅

聊天系统中的对话也不像 GitHub 中那样容易搜索，所以问题和答案可能会在对话中丢失。只有在 GitHub 中的对话才算作成为 FastAPI 专家，所以你更有可能在 GitHub 中获得更多关注。

另一方面，聊天系统中有成千上万的用户，所以很有可能你随时都能找到人聊天。😄

你也可以通过 GitHub sponsors 对作者（我）进行经济支持。

你可以在那里给我买杯咖啡☕️以表示感谢。😄

你也可以成为 FastAPI 的银牌或金牌赞助商。🏅🎉

正如你在文档中看到的，FastAPI 站在巨人的肩膀上，Starlette 和 Pydantic。

你也可以赞助：

感谢！🚀

Was this page helpful?