コンテンツにスキップ

FastAPI ヘルプ - ヘルプを得る

FastAPI はお好きですか？

FastAPI、他のユーザー、および作者を支援したいですか？

または、FastAPI のヘルプが必要ですか？

支援するための非常に簡単な方法があります（いくつかクリックを1回または2回行うだけです）。

また、ヘルプを得るための方法もいくつかあります。

ニュースレターの購読

（頻繁ではありませんが）FastAPI and friends ニュースレターを購読して、以下の最新情報を入手できます

  • FastAPI と friends に関するニュース 🚀
  • ガイド 📝
  • 機能 ✨
  • 破壊的な変更 🚨
  • ヒントとコツ ✅

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 Expertになるでしょう。🎉

ただ、最も重要な点は、親切にすることです。人々は不満を持ってやってくることが多く、多くの場合、最善の方法で質問しません。しかし、できる限り親切にしてください。🤗

FastAPIコミュニティが親切で歓迎的であることが理想です。同時に、他人に対するいじめや無礼な行為は受け入れないでください。私たちはお互いを大切にする必要があります。

質問（ディスカッションやIssue）で他の人を助ける方法は以下の通りです。

質問を理解する

  • 質問者の目的とユースケースを理解できるか確認してください。

  • 次に、質問（そのほとんどは質問です）が明確かどうかを確認してください。

  • 多くの場合、質問はユーザーが想像した解決策に関するものですが、より良い解決策があるかもしれません。もしあなたが問題とユースケースをより良く理解できれば、より良い代替解決策を提案できるかもしれません。

  • もし質問を理解できない場合は、より多くの詳細を尋ねてください。

問題を再現する

ほとんどの場合、そしてほとんどの質問には、質問者の元のコードに関連する何かがあります。

多くの場合、彼らはコードの一部だけをコピーしますが、それでは問題を再現するには不十分です。

  • あなたは彼らに最小限の、再現可能な、例を提供してもらうように頼むことができます。それは、あなたがコピーペーストしてローカルで実行し、彼らが見ているのと同じエラーや動作を確認したり、彼らのユースケースをより良く理解したりすることができます。

  • もしあなたが寛大すぎると思うなら、問題の説明に基づいて、自分でそのような例を作成することもできます。ただし、これには多くの時間がかかる可能性があり、まず問題を明確にするように頼む方が良いかもしれません。

解決策を提案する

  • 質問を理解できた後、可能な回答を彼らに与えることができます。

  • 多くの場合、彼らの根本的な問題やユースケースを理解する方が良いでしょう。なぜなら、彼らがやろうとしていることよりも良い解決方法があるかもしれないからです。

クローズを依頼する

もし彼らが返信してきたら、あなたは彼らの問題を解決した可能性が高いです。おめでとうございます、あなたはヒーローです！🦸

  • さて、もしそれが彼らの問題を解決したなら、あなたは彼らに以下のことを依頼することができます。

    • GitHub Discussionsの場合：コメントを回答としてマークする。
    • GitHub Issuesの場合：Issueをクローズする。

GitHubリポジトリをウォッチする

GitHub で FastAPI を「ウォッチ」できます（右上の「ウォッチ」ボタンをクリック）：https://github.com/fastapi/fastapi。 👀

「Releases only」の代わりに「Watching」を選択すると、誰かが新しいIssueや質問を作成したときに通知を受け取ります。また、新しいIssue、ディスカッション、PRなどに関する通知のみを受け取るように指定することもできます。

そして、あなたはそれらの質問を解決するのを手伝うことができます。

質問をする

例えば、GitHubリポジトリで新しい質問を作成することができます。

  • 質問をしたり、問題について尋ねたりする。
  • 新しい機能を提案する。

注意：もしあなたがそれをするなら、私も他の人を助けるようにあなたに頼むつもりです。😉

プルリクエストをレビューする

あなたは他の人からのプルリクエストをレビューするのを手伝うことができます。

繰り返しますが、できる限り親切にするようにしてください。🤗

プルリクエストをレビューする際に留意すべきことと、レビュー方法を以下に示します。

問題を理解する

  • まず、プルリクエストが解決しようとしている問題を理解していることを確認してください。GitHub DiscussionまたはIssueでより長い議論があるかもしれません。

  • また、問題が別の方法で解決できるため、プルリクエストが実際には必要ない可能性も十分にあります。その場合、あなたはそれを提案したり、尋ねたりすることができます。

スタイルについて心配しない

  • コミットメッセージのスタイルなどのことはあまり気にしないでください。私はコミットを手動でカスタマイズしてスカッシュおよびマージします。

  • また、スタイルルールについても心配しないでください。すでに自動化されたツールがチェックしています。

また、他のスタイルや一貫性の必要性がある場合は、直接それを尋ねるか、必要な変更を加えてコミットを追加します。

コードを確認する

  • コードを確認して読んで、それが理にかなっているかどうかを確認し、ローカルで実行して、実際に問題を解決するかどうかを確認してください。

  • 次に、あなたがそれを行ったとコメントしてください。そうすれば、あなたが実際にそれをチェックしたことが私にわかります。

情報

残念ながら、私は単に複数の承認があるだけのPRを信用することはできません。

説明が魅力的であるため、3つ、5つ以上の承認があるPRが何度かありましたが、PRを確認すると、実際には壊れていたり、バグがあったり、解決すると主張する問題を解決していなかったりしました。😅

そのため、実際にコードを読んで実行し、コメントでそれを私に知らせることが本当に重要です。🤓

  • もしPRが簡略化できる方法があれば、あなたはそれを尋ねることができますが、あまりうるさくする必要はありません。主観的な視点が多く存在する可能性があり（そして私自身の視点も持つでしょう🙈）、基本的なことに集中できる方が良いでしょう。

テスト

  • PRにテストがあるかどうかをチェックするのを手伝ってください。

  • PRの前にテストが失敗することを確認してください。🚨

  • 次に、PRの後にテストが合格することを確認してください。✅

  • 多くのPRにはテストがありません。テストを追加するように促したり、自分でいくつかのテストを提案したりすることもできます。それは最も時間を消費するものの1つであり、あなたがそれを大いに助けることができます。

  • そして、あなたが試したことをコメントしてください。そうすれば、あなたがそれをチェックしたことが私にわかります。🤓

プルリクエストを作成する

例えば、プルリクエストでソースコードに貢献することができます。

  • ドキュメントで見つけたタイプミスを修正するため。
  • このファイルを編集することで、あなたが作成または見つけたFastAPIに関する記事、ビデオ、またはポッドキャストを共有するため。
    • 対応するセクションの先頭にリンクを追加してください。
  • あなたの言語にドキュメントを翻訳するのを手伝うため。
    • 他の人が作成した翻訳をレビューするのを手伝うこともできます。
  • 新しいドキュメントセクションを提案するため。
  • 既存のIssue/バグを修正するため。
    • 必ずテストを追加してください。
  • 新しい機能を追加するため。
    • 必ずテストを追加してください。
    • 関連する場合は、必ずドキュメントを追加してください。

FastAPIの保守を手伝う

FastAPIの保守を手伝ってください！🤓

やるべきことはたくさんあり、そのほとんどはあなたができます。

今すぐできる主なタスクは以下のとおりです。

これらの2つのタスクは、最も時間を消費します。それがFastAPIを保守する主な仕事です。

もしあなたがそれを手伝うことができれば、あなたはFastAPIを維持するのを手伝っており、それがより速く、より良く進歩し続けることを保証しています。🚀

チャットに参加する

👥 Discordチャットサーバー 👥 に参加して、FastAPIコミュニティの他の人と交流しましょう。

ヒント

質問については、GitHub Discussionsで質問してください。そこでは、FastAPI Expertsによる支援を受ける可能性がはるかに高くなります。

チャットは、その他の一般的な会話のみに使用してください。

質問にチャットを使用しないでください

チャットではより「自由な会話」が可能になるため、あまりにも一般的で回答が難しい質問をするのが簡単になり、回答が得られない可能性があることに注意してください。

GitHubでは、テンプレートが適切な質問を書くように導くので、より簡単に適切な回答を得たり、質問する前に自分で問題を解決したりすることさえできます。そしてGitHubでは、たとえ時間がかかったとしても、すべてに必ず回答するようにできます。チャットシステムでは個人的にそれをすることはできません。😅

チャットシステムでの会話はGitHubほど簡単に検索できないため、質問と回答が会話の中で失われる可能性があります。そして、FastAPI ExpertになるためにカウントされるのはGitHubでのものだけなので、GitHubでより多くの注目を集める可能性が高いでしょう。

一方、チャットシステムには何千人ものユーザーがいるため、ほとんどの場合、そこで話をする相手を見つける可能性が高いです。😄

あなたはGitHubスポンサーを通じて、作者（私）を財政的に支援することもできます。

そこで、お礼としてコーヒー☕️を買うことができます。😄

そして、FastAPIのシルバーまたはゴールドスポンサーになることもできます。🏅🎉

ドキュメントで見たように、FastAPIは、巨人の肩の上、すなわちStarletteとPydanticの上に立っています。

あなたは以下もスポンサーすることができます。

ありがとう！🚀