Lamao LiveAPI より: 超便利な API ドキュメントの構築 (パート II)

前回の投稿では、パートタイムで働く学生の小さなチームが API の収集と実行を簡素化するツールである Lama2 を構築した方法を共有しました。

これはすぐに私たちのワークフローに不可欠な部分になりましたが、API リポジトリが成長するにつれて、Lama2 の手動プロセスには限界が見え始めました。

Lama2 のスケーリングの課題

私たちが始めたとき、私たちのチームはアルバイトと勉強を両立させる5人の学生で構成されていました。

私たちは毎日 3 ～ 4 時間働き、しばしば自分たちの限られた能力の限界を押し広げました。 Lama2 は、当時私たちが構築していた 3 つのプロジェクトのうちの 1 つにすぎませんでした。

制約にもかかわらず、Lama2 は Hacker News で好評を博しました。この製品の初期の支持者も何人か獲得しました。 CLI ツールおよびニッチな言語としては、堅実な反応でした。

しかし、機能の出荷には予想よりも時間がかかりました。私たちが競争する準備が整った頃には、API クライアントの市場はすでに混雑していました。

同様の製品にフルタイムで取り組んでいる確立されたチームは、熱心な取り組みと支援を通じて牽引力を獲得しました。 Lama2 は実際の問題を解決しましたが、私たちが想像していたような広範な話題を生み出すことはできませんでした。

私たちは、Lama2 が真の影響を与えるためには、単なる実行ツール以上のものが必要であることに気付きました。

Lama2 のスケーリングの課題

私たちが始めたとき、私たちのチームはアルバイトと勉強を両立させる5人の学生で構成されていました。

私たちは毎日 3 ～ 4 時間働き、しばしば自分たちの限られた能力の限界を押し広げました。 Lama2 は、当時私たちが構築していた 3 つのプロジェクトのうちの 1 つにすぎませんでした。

制約にもかかわらず、Lama2 は Hacker News で好評を博しました。この製品の初期の支持者も何人か獲得しました。 CLI ツールおよびニッチな言語としては、堅実な反応でした。

しかし、機能の出荷には予想よりも時間がかかりました。私たちが競争する準備が整った頃には、API クライアントの市場はすでに混雑していました。

同様の製品にフルタイムで取り組んでいる確立されたチームは、熱心な取り組みと支援を通じて牽引力を獲得しました。 Lama2 は実際の問題を解決しましたが、私たちが想像していたような広範な話題を生み出すことはできませんでした。

私たちは、Lama2 が真の影響を与えるためには、単なる実行ツール以上のものが必要であることに気付きました。

手動 API ドキュメントの問題

Lama2 を使用したとしても、大規模な API コレクションを維持するのは困難でした。当初は、すべてのサービスの API を 1 つのリポジトリに収集するのが管理しやすいと感じられました。しかし、4 つのバックエンドと数百の API にスケールアップすると、プロセスは膨大なものになりました。

私たちは、API の変更を手動で文書化して同期することがどれほど面倒であるかを身を持って知っていました。そして、私たちだけではありませんでした。大規模な API コレクションを扱うとき、すべての開発者がこの課題に直面します。

自動化のビジョン

私たちはワークフローを自動化し、API ドキュメントを簡単に作成し、実行をシームレスにする必要があることを認識していました。私たちの目標は、手動の手順を排除し、次のことができるツールを作成することでした。

1. メタタグなどを設定する必要がなく、コードがマージされると API を自動的に文書化します。
2. 変更があるたびにドキュメントを最新の状態に保ちます
3. 組織内の誰でも簡単に API を実行できるようにします

私たちの目標はシンプルでした:「非常に便利な API ドキュメント」

次のようなシステムを想像してください。

• 入力: リポジトリ リンク
• 出力: コミットごとに最新の状態に保たれる、完全に文書化された API。

LiveAPIの構築

このビジョンを実現するために、私たちは次の主要な機能を備えて設計されたプラットフォームである LiveAPI の開発を開始しました。

1. ワンクリック リポジトリ接続: 開発者は、GitHub、GitLab、または Bitbucket リポジトリに簡単に接続できます。
2. 自動ドキュメント生成: ドキュメントはコミットごとに自動的に生成され、自動同期により最新の状態に保たれます。
3. 自動化されたコード スニペット: あらゆる言語のコード スニペットを生成し、フロントエンド開発者が迅速に作業を進めることができるようにします。
4. 開発者に優しいエクスペリエンス: 最小限のセットアップで最大限の利便性を実現します。
5. プライバシーを第一に考えた LiveAPI ランナー:
   • 私たちがリポジトリのコードを保存することはありません。
   • ロジックを使用して、ルートと API バリデータのみを抽出します。
   • このプロセス全体はプライベート サーバー上で実行され、データがインフラストラクチャから離れることはありません。

言葉を広める

数か月にわたる作業を経て、LiveAPI の準備が整いました。私たちは、API の管理と文書化の煩わしさを軽減し、チームが文書の検討ではなく機能の構築に集中できるようにするツールを構築しました。

さあ、私たちが構築したものを世界と共有する時が来ました。ワークフローをよりスムーズにし、ドキュメントを簡単に作成できる非常に便利な API ドキュメント生成 ツールをお探しの場合は、LiveAPI を試してみてください。

これをチェックして、チームの API 管理プロセスをどのように変革できるかを確認してください。

私とつながってください

あなたの考えや経験をぜひ聞きたいです。早期アクセスについて、また LiveAPI が組織でどのように機能するかを確認するには、X でお問い合わせください。一緒に API 管理を簡単にしましょう!

以上がLamao LiveAPI より: 超便利な API ドキュメントの構築 (パート II)の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。