跳到内容

帮助 FastAPI - 获取帮助

你喜欢 FastAPI 吗？

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

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

有非常简单的帮助方式（有些只需一两下点击）。

也有多种获取帮助的方式。

订阅新闻通讯

你可以订阅（不常发送的）FastAPI 及伙伴新闻通讯，以获取以下方面的最新信息：

  • FastAPI 及伙伴的新闻 🚀
  • 指南 📝
  • 功能 ✨
  • 重大变更 🚨
  • 技巧与窍门 ✅

在 Twitter 上关注 FastAPI

在 Twitter 上关注 @fastapi 以获取关于 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（我喜欢听这些）。
    • 了解我何时发布公告或新工具。
    • 你也可以在 Twitter 上关注 @fastapi（这是一个独立的账号）。
  • 在 LinkedIn 上关注我.
    • 了解我何时发布公告或新工具（尽管我更常用 Twitter 🤷‍♂）。
  • 在 Dev.to 或 Medium 上阅读我所写的内容（或关注我）。
    • 阅读其他想法、文章，并了解我创建的工具。
    • 关注我以阅读我发布的新内容。

发推提及 FastAPI

发推提及 FastAPI，让我和他人知道你为什么喜欢它。🎉

我喜欢了解 FastAPI 的使用情况，你喜欢它哪些方面，你正在哪个项目/公司中使用它等等。

为 FastAPI 投票

在 GitHub 上帮助他人解决问题

你可以在以下地方尝试帮助他人解决问题：

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

如果你帮助很多人解决了他们的问题，你将成为一名官方的 FastAPI 专家。🎉

请记住，最重要的一点是：尽量友善。人们带着沮丧而来，在许多情况下没有以最好的方式提问，但请尽你所能保持友善。🤗

我们的理念是让 FastAPI 社区友善且热情。同时，不接受欺凌或对他人不尊重的行为。我们必须互相照顾。

以下是如何在（讨论或问题中）帮助他人解决问题：

理解问题

  • 检查你是否能理解提问者的目的和使用场景。

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

  • 在许多情况下，提问者提出的问题是关于他们设想的解决方案，但可能存在一个更好的方案。如果你能更好地理解问题和使用场景，你或许能够提出一个更好的替代方案。

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

复现问题

在大多数情况下，以及对于大多数问题而言，都与提问者的原始代码有关。

在许多情况下，他们只会复制部分代码片段，但这不足以复现问题。

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

  • 如果你过于慷慨，可以尝试根据问题的描述自己创建一个示例。但请记住，这可能需要大量时间，最好先请他们澄清问题。

提出解决方案

  • 理解问题后，你可以给他们一个可能的答案。

  • 在许多情况下，最好理解他们潜在的问题或使用场景，因为可能存在比他们尝试的方法更好的解决方案。

请求关闭

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

  • 现在，如果这解决了他们的问题，你可以请他们：

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

关注 GitHub 仓库

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

如果你选择“关注”（Watching）而不是“仅发布”（Releases only），当有人创建新问题或提问时，你将收到通知。你也可以指定只接收关于新问题、讨论或拉取请求等的通知。

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

提问

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

  • 提出问题或就问题进行咨询。
  • 建议一个新功能。

注意：如果你这样做，我也会请你帮助其他人。😉

审查拉取请求

你可以帮助我审查其他人的拉取请求。

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

以下是审查拉取请求时需要注意的事项和方法：

理解问题

  • 首先，请确保你理解该拉取请求试图解决的问题。它可能在 GitHub Discussion 或 issue 中有更长的讨论。

  • 此外，很有可能这个拉取请求实际上不需要，因为问题可以用不同的方式解决。那样的话，你可以提出建议或询问。

不用担心风格

  • 不用太担心提交信息风格之类的事情，我会在合并时手动定制提交信息。

  • 也不用担心风格规则，已经有自动化工具进行检查了。

如果还有其他风格或一致性需求，我会直接提出，或者添加提交来包含所需的更改。

检查代码

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

  • 然后评论说明你这样做了，这样我就会知道你确实检查过了。

信息

不幸的是，我不能简单地信任那些只有几个批准的拉取请求。

多次出现这样的情况：有些拉取请求有3个、5个或更多的批准，可能是因为描述很吸引人，但当我检查这些拉取请求时，它们实际上是损坏的，存在 bug，或者没有解决它们声称要解决的问题。😅

因此，你实际阅读并运行代码，并在评论中告知我你这样做了，这真的非常重要。🤓

  • 如果拉取请求可以以某种方式简化，你可以提出要求，但没必要过于挑剔，可能存在许多主观的观点（我也有我自己的🙈），因此最好能专注于基本的东西。

测试

  • 帮助我检查拉取请求是否包含测试。

  • 检查在拉取请求之前，测试是否失败。🚨

  • 然后检查在拉取请求之后，测试是否通过。✅

  • 许多拉取请求没有测试，你可以提醒他们添加测试，甚至可以自己提出一些测试。这是最耗时的任务之一，你可以在这方面提供很大帮助。

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

创建拉取请求

你可以通过拉取请求为源代码贡献，例如：

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

帮助维护 FastAPI

帮助我维护 FastAPI！🤓

有很多工作要做，其中大部分你都可以完成。

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

这两项任务是最耗时的。它们是维护 FastAPI 的主要工作。

如果你能在这方面帮助我，你就是在帮助我维护 FastAPI，并确保它能更快更好地发展。🚀

加入聊天

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

提示

如有问题，请在GitHub Discussions 中提问，你更有可能获得FastAPI 专家的帮助。

聊天仅用于其他一般性对话。

不要在聊天中提问

请记住，由于聊天允许更“自由的对话”，所以很容易提出过于笼统且难以回答的问题，因此你可能无法收到答案。

在 GitHub 中，模板会引导你提出正确的问题，以便你更容易获得好的答案，甚至在提问之前自己解决问题。在 GitHub 中，我可以确保总是回答所有问题，即使需要一些时间。我个人无法在聊天系统中做到这一点。😅

聊天系统中的对话也不像 GitHub 那样容易搜索，所以问题和答案可能会在对话中丢失。而且只有 GitHub 上的贡献才计入成为 FastAPI 专家的条件，因此你很可能会在 GitHub 上获得更多关注。

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

如果你的产品/公司依赖或与 FastAPI 相关，并且你想触达其用户，你可以通过GitHub 赞助来赞助作者（我）。根据赞助等级，你可能会获得一些额外的好处，例如文档中的徽章。🎁

谢谢！🚀