apihub
v1.3.0
プログラミング言語でのAPI処理を学習するために使用できる単一のソースAPIハブを構築しようとしています。ユーザーは、このAPIハブを使用して、Webおよびモバイルアプリでフロントエンドポートフォリオを構築できます。
Freeapiプロジェクトは、開発者にプロジェクトに無料でアクセス可能なAPIを提供することを目的とした革新的でコミュニティ主導のイニシアチブです。
このプロジェクトは、さまざまなドメインや機能に対応する幅広いAPIの提供に焦点を当てており、開発者がこれらのAPIをアプリケーションにシームレスに統合できるようにします。
Freeapiプロジェクトの重要なハイライトは次のとおりです。
アクセシビリティ： Freeapiプロジェクトは、APIのコレクションへの無料アクセスを提供することにより、障壁を排除することに取り組んでいます。開発者は、コスト制限なしにこれらのAPIを活用して、革新的なアプリケーションを実験、学習、構築することができます。
多様なAPIコレクション：このプロジェクトは、さまざまな業界、ドメイン、および機能にまたがるAPIの多様で包括的なコレクションを提供します。ソーシャルメディアの統合、支払いゲートウェイ、機械学習アルゴリズム、またはIoTデバイスの接続が必要な場合でも、Freeapiプロジェクトで説明しています。
簡素化された統合： Freeapiプロジェクトは、APIをアプリケーションに統合する際に開発者が直面する課題を理解しています。これに対処するために、プロジェクトは明確なドキュメント、コードサンプル、およびSDKを提供し、統合プロセスを簡素化し、開発時間と労力を短縮します。
コミュニティ主導の開発：このプロジェクトは、開発者の活気に満ちた共同コミュニティを促進します。貢献者は、知識を共有し、議論に従事し、API関連のプロジェクトで協力することをお勧めします。この集合的な努力により、Freeapiプロジェクトが提供するAPIの継続的な改善と信頼性が保証されます。
学習とスキル開発： Freeapiプロジェクトは、学習とスキル開発のためのプラットフォームを提供することにより、開発者に力を与えることを目的としています。さまざまなAPIや教育リソースへのアクセスを通じて、開発者はAPI統合の理解を高め、知識を拡大し、完全なプロジェクトを構築することで専門知識を紹介できます。
全体として、Freeapiプロジェクトは、アクセス可能で多様なAPIを求める開発者にとって貴重なリソースです。
支援コミュニティを促進することにより、プロジェクトは開発者が学習、作成、革新することを可能にし、最終的にはAPI統合状況の成長と進歩に貢献します。
画期的なオープンソースAPIハブプロジェクトを紹介します。これは、開発者がAPIとの対話方法に革命をもたらすために設計された動的なプラットフォームです。
API Hubは、開放性、アクセシビリティ、学習に重点を置いて、あらゆるレベルの開発者がAPI統合のスキルを探求、実験、成長させることができます。
ハイライト：
オープンソース： APIハブは、オープンソースの原則に基づいて構築されており、透明性、コラボレーション、コミュニティ主導の開発を確保しています。これは、ソースコードが自由に利用できるため、開発者がプロジェクトをカスタマイズ、拡張、貢献できることを意味します。
自由に使用できる：私たちは入場の障壁を取り除くことを固く信じています。そのため、APIハブは完全に自由に使用できます。ベテランの開発者であろうと、コーディングの旅を始めたばかりであろうと、コスト制限なしでプラットフォームを活用できます。
ローカルまたは展開：柔軟性はAPIハブの中核にあります。ローカルで使用したり、独自のマシンで実行したり、サーバーに展開して他の人がアクセスできるようにするオプションがあります。この汎用性により、プラットフォームを特定の開発環境に適応させることができます。
学習リソース：APIハブは包括的な学習リソースとして設計されており、豊富な教育資料、チュートリアル、ドキュメントを提供しています。あなたが初心者であろうと、APIの知識を拡大しようとしているかどうかにかかわらず、当社のプラットフォームは、学習と改善に必要なリソースを提供します。
初心者向けのカスタムエンドポイント：初心者レベルの開発者向けに、API HubはAPI応答の処理に実践的なエクスペリエンスを提供するカスタムエンドポイントを提供します。これらの初心者向けのAPIを使用すると、APIを使用することの基本に練習し、慣れることができます。
ポートフォリオビルディング用の高度なAPI ：初心者レベルのエンドポイントに加えて、当社のAPIハブは、スキルに挑戦して伸ばすための高度なAPIも提供します。これらのAPIを使用すると、より複雑な統合シナリオに取り組むことができ、専門知識を紹介するプロジェクトの堅牢なポートフォリオを構築することができます。
オープンソースの原則、アクセシビリティ、学習に焦点を合わせることにより、API Hubプロジェクトは、開発者がAPI統合の世界で繁栄する方法を開きます。私たちの活気に満ちたコミュニティに参加し、発見、成長、革新のエキサイティングな旅に着手してください。
オープンソースプロジェクトは現在、リモートサーバーでホストされており、追加コストの発生を避けるために、 2時間ごとにファイルシステムやMongoDBデータベースを含むサーバー全体をリセットすることを余儀なくされています。
このプロセスにより、すべての画像/静的ファイルが削除され、サーバー上のデータベース全体がリセットされます。
データの損失：アップロードされた画像やユーザーデータを含む2時間の間隔（リモートサーバー上）に行われた変更は、失われ、回復不能になります。
サービスの中断：サーバーのリセットは、サーバーが再起動している間（1〜2分間）、特定の期間にわたって開発とテストプロセスを中断する可能性があります。
ローカルAPIの使用：開発とテストの目的で、プロジェクトをクローニングしてマシンでAPIをローカルに使用することを強くお勧めします。
これにより、作業がサーバーのリセットの影響を受けず、ローカルマシンで安定した開発環境を維持できるようになります。
鉄道での自己ホスト（個人プロジェクトに推奨） ： Freeapi.Appアプリケーションを自己ホストするには、すぐに利用できる事前に構築されたテンプレートを利用できます。詳細なドキュメントについては、ここをクリックしてください
Freeapiプロジェクトを実行するには、次の手順に従ってください。
.envファイルを作成し、 .env.sampleのコンテンツを貼り付け、必要な資格情報を追加します。docker-compose up --build --attach backend
# --build: Rebuild the image and run the containers
# --attach: only show logs of Node app container and not mongodbFreeapiプロジェクトをローカルに実行するには、次の手順に従ってください。
.envファイルを作成し、 .env.sampleのコンテンツを貼り付け、必要な資格情報を追加します。yarn installyarn startfreeapi.appアプリケーションを自己ホストするには、すぐに利用できる事前に構築されたテンプレートを利用できます。
上のボタンをクリックして、Railway.Appにアクセスします。
[今すぐ展開]ボタンをクリックします。
（オプション）githubでサインインして展開します。
リポジトリの詳細を入力してください。
環境変数の場合、envに負担を軽減するためにENVにいくつかのデフォルト値を提供しましたが、いくつかのパラメーターは必須です。
PORT ：値を変更しないで、展開後にSwaggerドキュメントを表示するために8080に設定します。MONGODB_URI ：Mongodb AtlasデータベースURLを提供します。例が登録されています。編集/更新して続行します。NODE_ENV ：デフォルトは「開発」に設定され、ログを表示します。それらを「生産」に変更することを選択できます（必ず同じ単語を追加してください）。EXPRESS_SESSION_SECRET ：デフォルト値を独自の秘密値に変更することをお勧めします。ACCESS_TOKEN_SECRET ：デフォルト値を独自の秘密値に変更することをお勧めします。ACCESS_TOKEN_EXPIRY ：デフォルトとして1日に設定します。REFRESH_TOKEN_SECRET ：デフォルト値を独自の秘密値に変更することをお勧めします。REFRESH_TOKEN_EXPIRY ：デフォルトとして10日間に設定します。FREEAPI_HOST_URL ：生成された鉄道URLとして設定します。必要な環境パラメーターを記入したら、PayPal、Google、Razorpayなどの他のパラメーターを追加する場合は、フォームの資格情報に言及してください。
展開ボタンをクリックして、最初のビルドをトリガーします。
注：アプリケーションが展開されたら、Swaggerドキュメントが利用可能になるまで3〜5分待ってください。
エンドユーザーの信頼性と安定性を確保するために、すべてのエンドポイントでテストを自動化するための強力なテストフレームワークであるPlaywrightを利用しています。
.envファイルにMONGO_MEMORY_SERVER_PORT=10000 （e2eテスト用のmongodbポート）を必ず追加してください。
yarn start:test-serveryarn test:playwrightこれにより、劇作家レポートが生成されます。このレポートを表示するには、次のコマンドを実行します
yarn playwright show-report変更を加えるたびに、すべてのテストケースが合格していることを確認してください。
オープンソースプロジェクトに貢献することにあなたの関心を歓迎します！
Freeapiに貢献するには、次の手順に従ってください。
git checkout -b feat/your-feature-nameまたはgit checkout -b fix/your-bug-fix-nameて変更します。git commit -am 'add your commit message'git push origin feat/your-feature-name 。APIハブに効果的に貢献する方法に関するガイドを次に示します。
README更新のリクエストをプルする：プロジェクトのREADMEファイルを更新するためだけに、プルリクエストの送信を控えてください。明確で簡潔なドキュメントの重要性を高く評価していますが、実質的なコードの貢献と機能の強化に焦点を当てることを好みます。
文法の更新：私たちのチームは効果的なコミュニケーションを大切にしていますが、私たちは文法スティックラーではありません。文法の修正やマイナーな言語の改善のためだけに、プルリクエストを送信する必要はありません。代わりに、プロジェクトのコア機能と機能に集中します。
既存のパブリックAPIの更新を避ける：安定性と一貫性を維持するために、APIハブ内の既存のパブリックAPIへの直接更新を思いとどまらせます。これらのAPIは徹底的にテストされ、承認されています。ただし、バグや問題が発生した場合は、プロジェクトの問題トラッカーに問題を開き、通知することをお勧めします。
新しいプロジェクトAPIを構築する：完全なプロジェクトAPIを構築することで、創造性を探求し、貢献することをお勧めします。これらのAPIは、開発者がスキルと能力を紹介する複雑なプロジェクトを構築するのを支援できる包括的なソリューションを提供する必要があります。この分野でのあなたの貢献は、コミュニティに大きな利益をもたらします。
提案を起草し、Discordについて議論する：プロジェクトに飛び込む前に、提案を起草することをお勧めします。これには、構築する予定のAPIのマインドマップまたはアウトラインとその潜在的な利点が含まれます。私たちのDiscordコミュニティに参加してください。ここでは、提案を共有し、アイデアについて話し合い、仲間の貢献者からフィードバックを集めてください。これらの議論に従事することで、バックエンドポートフォリオが強化され、プロジェクトの将来の方向性が形成されます。
私たちはあなたの熱意に感謝し、私たちのオープンソースAPIハブプロジェクトへのあなたの貴重な貢献を楽しみにしています。
一緒になって、共同環境を促進し、API統合の状況に大きな影響を与えることができます。
詳細な貢献ガイドについては、ここをクリックしてください。
Freeapisを消費するFrontEndアプリケーションを作成して、Freeapiプロジェクトに貢献してくれてありがとう！あなたの努力は、ユーザーエクスペリエンスを強化し、APIの範囲を拡大する上で重要な役割を果たします。このガイドに従って、スムーズで協力的な貢献プロセスを確保してください。
フロントエンド開発者向けの詳細な寄付ガイドについては、ここをクリックしてください！
Freeapiプロジェクトに貢献して、戦場でテストされた堅牢なエンドポイントを出荷するのに役立つAPIサービスのコードカバレッジを増やすことに感謝します。このガイドに従って、スムーズで協力的な貢献プロセスを確保してください。
コードカバレッジを増やすための詳細な寄付ガイドについては、ここをクリックしてください。
swagger docs：https：//api.freeapi.app
注： swagger.yamlファイルからswagger docsは自動生成されます。プロジェクトをローカルで実行している間、swagger docs servers/urlフィールドのhttp://localhost:<port_from_.env>/api/v1にURLを変更してください。
