javascript - 良い例/テンプレート/ベストプラクティスAPIドキュメント

javascript python ajax api specifications

私はWebサービスのフロントエンドを作成し、別の会社はバックエンドを作成しています。私たちは、互いに混乱することなく共同で編集できるAPI呼び出しのドキュメントを作成する、シンプルでわかりやすい優れた方法が必要です。

プロジェクトAPIドキュメントの優れた仕様/例などがあるので、これは多くの書き換えで大きな混乱に陥ることはありませんか?
答え
文書化のための私の選択:Sphinx

その他:


epydoc
pylit


しかし、スフィンクスは非常に素晴らしいです。
関連記事

javascript - Javascriptを目立たなくするのに助けが必要

javascript - n番目のユーザーごとにJavaScript関数を呼び出す

javascript - jqueryモバイル-日付ピッカーの問題

javascript - jQueryアコーディオンがアクティブ:IDタグを使用してFirefoxで機能しない

java - 複数の入力フィールドを持つHTMLフォーム

javascript - 文字列/テキスト入力フィールドをJavaScript ifステートメントの条件として使用する

javascript - 理由を教えてください:フルJS / HTMLフロントエンドを備えたSinatra API

javascript - JavaScript:イベントリスナーの「this」キーワードに関する問題

php - PHP変数をJavaScriptとJavaScriptのifステートメントに渡す[重複]

javascript - イベントリスナーで複数の要素を追加する最も速い方法は?ウィンドウのクリックを聞いて悪いですか?