ペーストするだけ、解析も完了。EchoAPIが雑なドキュメントを即座に機能するAPIリクエストに変換する方法

私は一日中APIを書いています。その部分は簡単です。

しかし、読みにくいドキュメントしかない第三者のAPIをテストするところが、本当の苦しみのはじまりです。
SMSを統合していると思っていたら、デットシー・APIのようなあいまいなパラメータのスクロールを解読することになりました。

おなじみの話ですか？

SwaggerもPostmanコレクションもOpenAPIファイルもなく、どこに何を書くかもわからないテキストの壁を眺めたことがあるなら——私だけではありません。私もそこにいました。そのせいでプロジェクトを断念しそうになったことがありました……でも、ゲームを変えるツールを見つけました：EchoAPIのAI解析インポート機能です。

これがAPIです！——つまり、運を天に任せるしかありません

先週、製品チームが第三者のSMSプロバイダーと統合することになりました。私はドキュメントを開いて、Swagger、ポストマンコレクション、または基本的なOpenAPIファイルのようなものが出てくると期待しました。

違いました。

出てきたのは……ウェブページです。そこに……テキストがあります。

POST https://api.thirdparty-sms.com/send 

Params:
phoneNumber: ユーザーの電話番号
message: メッセージの内容
sign: 認証署名（バックエンドから）

戻り値：
{
  "code": 0、
  "msg": "success"
}

それだけです。構造もありません。ツールにやさしいフォーマットもありません。あいまいなテキストの塊で「頑張ってね」と言っているかのようです。

私はこう思いました：

「クールクールクール……じゃあ、私は手動でリクエストをゼロから作って、コンマも見逃さずに願おう」

ドキュメントはJavaで話すけど、私は理解できません

有望そうに見えるもう一つのAPIプロバイダーを見つけました——もっとエンタープライズ向けです。
でも、彼らのドキュメントは、字義通りのJavaコードスニペットです。

HttpPost post = new HttpPost("https://api.weather.com/getWeather");
params.add(new BasicNameValuePair("city"、"London"));
params.add(new BasicNameValuePair("unit"、"celsius"));

素晴らしい。私は今、古代ギリシャ語を翻訳するような気持ちでJavaを理解しようとしています。
私——Python/Golang開発者——がこの何かポストマンかcurlが理解できるものに頭の中で変換しようと試みているのです。

私は言語交換プログラムにサインアップした覚えはありません。

たった一つのシンプルなエンドポイント。三十分钟の苦しみ。

本当にひどいのは？

私はAPIが難しかったから詰まっていたわけではないです。それは基本的なものでした。
ひどかったのはプロセスです：

• ドキュメントをランダムにノートンにコピーして整理する
• フォーマットと言語の間で翻訳する
• リクエスト定義を手書きする
• タイポや漏れたパラメータをデバッグする

すべてが……「送信」を押す前にです。

そして、プロバイダーがあなたに单一のcURLを与え、デジタル考古学者のようにすべてを逆エンジニアリングしろと言っている場合、どうかご自分を助けてください。

EchoAPIのAI解析インポート：ペースト、解析、完了。

私はもう我慢の限界に達しようとしていたとき、チームメイトがスラックで私に言いました：

「エコーAPIを試してみたらどうですか。それはこのAIインポート機能があります——ドキュメントをペーストするだけです」

私は鼻で笑いました。

「うんうん。次に、それは私の考えを読んでテストを書きまでもあると言うibile»

でも、試してみることにしました。私はこの雑なテキストだけのAPIをコピーしました：

POST /sendMessage  
パラメータ：  
- userId  
- content  
- トークン  

戻り値：  
{"status": "ok"、"data":{"messageId": "abc123"}}

👉 ペースト → 「AI解析」を選択 → インポートをクリック

バン。
数秒で、完全に構造化されたリクエストができました：メソッド、URL、ヘッダー、パラメータ、サンプルレスポンスまで。
私は一行も手動で触りませんでした。

私は瞬きました。画面を更新しました。また瞬きました。
これは現実生活ですか？

言語をまたがる解析：それはGoと.NETを読み解くこともできました

運試しに、このランダムなGoコードをペーストしてみました：

req、_ := http.NewRequest("POST"、"https://api.payment.com/pay"、nil)
q := req.URL.Query()
q.Add("amount"、"100")
q.Add("currency"、"USD")

EchoAPIはメソッド、エンドポイント、パラメータを完璧に解析しました。

どうやらそれは以下のことをサポートしています：

• ラウドテキスト
• コードスニペット（Go、Java、.NETなど）
• cURLコマンド
• あいまいな自然言語の説明（本当にです）

APIリクエストに見えるものなら、EchoAPIはそれを解明します。

EchoAPIが実際に（あなたの理性以外に）何を節約するか

タブの切り替えはもう終わり、フィールドは必須ですか？トークンをどこに入れるの？という疑問ももう終わりです。

開発者がAPIドキュメントから本当に求めているもの

リクエストを設定すること自体は気にしません。
ただ、何度も何度も3つのフォーマットで、一貫性のないドキュメントを使って時間を浪費したくないのです。

私は次のことができたいです：

• 新しい統合をプラグインする
• リクエストを迅速に検証する
• 意味のある何かを構築することに集中する

スパゲッティドキュメントを逆エンジニアリングして詰まることはしたくありません。

EchoAPIはそれを理解しています。

次のような状況に遭遇したことがあるなら：

• ごったがえした公開API
• Swaggerもポストマンコレクションも-helpもなく
• ブログ記事にコードスニペットと祈りがある場合

EchoAPIのAI解析インポートが脱出ハッチです。

コピー→ペースト→インポート。
それだけです。

これで、私は半完成のドキュメントを解読する時間を無駄にすることなく、「送信」をクリックする準備ができています。

一度試してみましょう。将来のあなた（そして血圧）が感謝します。