理想的なAPIドキュメントはどのようにすべきですか？

Question

私は非常に多くのAPIを作成しています。私たちはそれを公開する予定です。非常に多くのAPIとその応答があります。各APIは、複数のパラメータセットで呼び出すことができ、呼び出しパラメータに応じて異なる結果セットを生成する可能性があります。

さまざまなパラメータでこのAPIをすべて文書化する方法はあまりありません。

Answer 1

新しいAPIを使用している間、私はいつもそのドキュメントが分かりやすいかチェックします。 可能であれば、あなたのAPI用のビデオチュートリアルを作成しようと思います（それは何ですか？また、それを使用する方法は何ですか？）すべてを事実上すべて説明するビデオより優れているものはありません。

書面による文書の場合は、apiから影響を受ける可能性のあるすべての細かい事項を精緻化していることを確認してください。 apiのすべての制限についても言及してください。開発者は言及すべきことをほとんど忘れてしまい、エンドユーザーがその制限を把握するまでに何時間もかかることがよくあります。

幸運を祈る！先に行く！