Apigit を初めて使用する場合に試す最初の 5 つのこと

Apigit では、API を民主化し、ユーザーが Apigit API プラットフォームで API を利用および構築できるようにすることで、API ファーストの世界を実現できるよう努めています。数万人を超えるユーザーを擁する当社は、リーチを拡大し続け、初心者から上級ユーザーまで、Apigit が提供する最高の機会へのアクセスを提供しています。

以下にリストされている特定の機能のいずれかにアクセスするには、まず Apigit アカウントを作成してサインインする必要があります。Apigit には、お好みのブラウザーから直接アクセスできます。

ログイン後、これら 5 つのエキサイティングな機能を試して、Apigit を使い始めることができます。

1. リポジトリを作成する

Apigit アカウントを作成したら、リポジトリの作成など、プラットフォームのさまざまな機能を試すことができます。リポジトリは、コードを保存して他のユーザーと共同作業できるスペースです。

リポジトリを作成するには、Apigit ダッシュボードの上部に移動し、+ サイン。ドロップダウン メニューから、New repository.次のページで、リポジトリの名前とオプションの説明を入力するよう求められます。この情報を入力したら、[リポジトリの作成] ボタンをクリックしてプロセスを終了します。

おめでとうございます。Apigit で最初のリポジトリが正常に作成されました。ファイルの追加、他のユーザーとの共同作業、プラットフォームの他の多くの機能の利用を開始できるようになりました。

最初のステップ: リポジトリを作成する

2. API 仕様を追加する

API 仕様を Apigit ダッシュボードに追加するには、+ 左上隅にあるサイン。次のようなパス名を入力します。test/myfirst.json、その他の関連情報title とversion.

新しい API 仕様を追加する前に、リポジトリで提供されている例を調べることができます。左サイドバーの 🪄 アイコンをクリックすると、別のビューアに切り替えることができます。たとえば、petstore-json-format.json からのファイルexamples フォルダを開き、ビューアをcode 仕様例の JSON 形式のコードを表示します。

API 仕様を編集するには、マウスをファイルの上に置き、⋮ ファイルの末尾にあるアイコンをクリックするか、ダッシュボードの左下にある ✏️ アイコンをクリックします。その後、例から JSON コードをコピーし、それを使用して独自の仕様を作成できます。これは、最初の API 仕様がどのようになるかの例です。

2 番目のステップ: API 仕様を追加する

3. モック サーバーを作成して公開する

モック サーバーは、完全に実装する前に API の動作をシミュレートするために、API 開発でよく使用されます。開発者は、モック サーバーを使用してコードをテストし、API が完了するのを待ったり、実際のサーバーにリクエストを送信したりすることなく、期待どおりに動作することを確認できます。

Apigit にモック サーバーをデプロイするプロセスは簡単です。まず、リポジトリに移動し、Mock Server Script ボタン。サーバー スクリプトが完成したら、サーバーを公開します。サーバーの URL は、Mock Servers トップメニューにあるページ。

3 番目のステップ: モック サーバーを作成して公開する

4. API テストを作成して公開する

API テストは、API が仕様に準拠していること、さまざまな種類の入力と出力を処理できること、エラーと例外を適切に処理できることを検証するプロセスです。 API テストは、手動で行うことも、API へのリクエストとレスポンスをシミュレートする自動ツールを使用して行うこともできます。

Apigit で API テストを開始するには、Test Cases リポジトリの下にあるボタン。ここでは、API テストの例を示します。独自のテスト ケースを作成し、baseurl 手順 3 で生成されたモック サーバー URL を使用します。

API テスト ケースを公開したら、API Testing ページ。をクリックすると、このページにアクセスできます。API Testing トップメニューのボタン。

4 番目のステップ: API テストを作成して公開する

5. 作品を共有する

Apigit は、作業を簡単に共有できる人気のある API コラボレーション プラットフォームです。 1 人の友人と小規模なプロジェクトに取り組んでいる場合でも、何百人もの開発者がパブリック API に積極的に取り組んでいるエンタープライズ企業の一員である場合でも、何を誰に表示するかを制御できます。

世界が見るべきものを作成した場合は、それを Apigit API ネットワークに公開できます。これにより、世界中の Apigit ユーザーがあなたのコレクションにアクセスできるようになります。

次のレベルへ

基本のいくつかを習得したので、時間をかけて Apigit のさらに便利な機能を調べて発見してください。たとえば、別の API の結果に依存する API テスト ケースを設計できることをご存知ですか?これをはじめ、プラットフォームで利用できる他の多くの便利なツールを調べてください。