文書にRest APIを定義するツールはありますか？

Question

Rest API to htmlドキュメントの生成に関する多くの質問があります。

しかし、卵は鶏肉に由来します。多くの場合

、アーキテクチャは、APIを定義する必要があります。これは、Web開発者とiOS/Androidクライアント開発者との関係です。

だから、ツールやウェブのような種類があり、我々は物事に従ってくださいすることができます

新 がsubURL を書くAPIはポストパラメータが返された答えに 書き込みを書く 書き込み POST/GETメソッドを書きますサンプル要求、任意の種類の状態、エラーコード。 この後、そこにdocまたはオンラインdoc htmlがあります。

私たちは、時間が通る後にそれを更新し、編集することができます。 Web /クライアントの開発者は、ドキュメントを見るだけで済み、準備が整いました。

これをアーカイブすることができるツールのいずれかの種類がありますか？ありがとうございました。

Answer 1

クライアントはRESTfulなAPIを発見することができ、文書のための仕様がいくつかあります。

• Swagger（demo）
• apiary
• JSON Home
• Googleがしかし他の人とは違って、残念ながら私はあなたからそれを公開し使用するのに役立つオープンソースのライブラリがあるとは思わない、Discovery Service自分自身を使用しますあなた自身のAPI

私が闊歩を使用している、それがうまく動作します。スペックは、あなたが言及しているものの扱い：

• JSONスキーマを記述するためのリクエスト/レスポンス
• エラーコードの一覧/条件
• をcodegen library JavaScriptなどの言語の数のクライアント側のコードを生成します、Java、Scala、Objectove-C、PHP、Python、Rubyなどがあります。