ホビー API 収集および実行ツールがどのように製品に進化するか

どのスタートアップでも、複数のサービスにわたる API の管理は共通の課題です。

私たちは 3 つの主要な問題に直面しました:

1. API のドキュメント化
2. ドキュメントの公開
3. API が変更されるたびに更新します

これらのそれぞれには、独自の一連の質問がありました。それをどのように行うか、どこで行うか、どのツールを使用するか、そして誰が所有権を取得するのか。

これに取り組むために、私たちのチームはすべての API を APIHub という単一のリポジトリに統合することにしました。各サービスの API は、シンプルで一貫した形式で保存されました。

GET | POST | PUT | DELETE | PATCH  
${baseurl}/endpoint  
{  
  "body": "if present"  
}

ファイルにはその機能に応じて名前を付けました。以下は、「Leave apply」API の .l2 ファイルの例と、リポジトリ内の他の API を示すサイドバーです:

文書作成慣行の改善

すべてのプル/マージ リクエストに、対応する .l2 ファイルを含めることを必須にしました。それが存在しない場合、リクエストは承認されません。この単純なルールにより、チーム全体の API ドキュメントの一貫性が向上しました。

文書化から実行まで

URL とペイロードを Postman などのツールにコピーして API を手動でテストするのは時間がかかることにすぐに気づきました。そこで、Lama2 という CLI ツールを構築しました。

Lama2 は、Git ベースのコラボレーション用に最適化されたプレーンテキストの API マネージャーです。

Lama2 を使用すると、.l2 ファイルを入力として渡すことができ、CLI が API を実行してターミナルに応答を表示します。

これにより、頻繁にコピー＆ペーストする必要はなくなりましたが、.l2 ファイルを見つけるためにディレクトリを切り替えるのは依然として面倒でした:

lovestaco@i3nux:~/apihub/feedback/fb_v3/leave$ l2 apply_leave.l2  

VSCode に持ち込む

作業をさらに合理化するために、VSCode 拡張機能を開発しました。ワークフローをさらにスムーズにする機能が搭載されています:

1. エディターで .l2 ファイルを直接実行する
2. 簡単に共有できるようにファイルの Git URL をコピーします
3. JSON ペイロードを整形する
4. .l2 構文から任意の言語のコード スニペットを生成
5. 新しい API のテンプレートを数秒で作成
6. LSP を使用した変数の自動補完

この拡張機能はすぐにチームのお気に入りになり、他の人にもメリットを提供できるように GitHub でリリースすることにしました。

次の問題: スケーリングに関するドキュメント

API が成長するにつれて、私たちは次のことを自問しました。

• 各サービスの API を手動で文書化する必要があるのはなぜですか?
• 変更のたびにドキュメントを更新するのは時間がかかりませんか?

そしてそこから私たちの旅の次の章が始まります...
私をフォローして、次の投稿で次に何が起こるかを学びましょう。

以上がホビー API 収集および実行ツールがどのように製品に進化するかの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。