APIを文書化する必要があります。それらのいずれかを使用する必要があります Slate または Swagger 。どちらがより良い選択肢、長所と短所を持っているか、どちらが優れているかを知りたいです。
SwaggerとSlateには2つの異なる目的があります。 Swaggerは、RESTful APIを記述する標準化された方法の試みです(たとえば、 ApiBlueprint と同様)
Swaggerは、JSONベースのAPI定義形式であり、REST APIの説明を許可します。
一方、スレートは、ニースAPIドキュメントを作成するためのかなりのテーマです。
Swaggerの目標は、他の人が広範なツール(たとえば、ドキュメント、APIエクスプローラー、モックサーバー、コード生成、テストユーティリティなど)を構築できる標準を提供することです。例: Swagger Tooling
質問の詳細:swaggerのスレートツール:
したがって、2つは相互に排他的ではありませんが、あなたの直接の質問に答えてください。
私の観点から見ると、これらのツールには非常に異なる目的があります。 Swaggerは記述言語ですが、slateはドキュメント用です。
私はswaggerを使用してdescriptionnを作成しました。この記述から、APIのさまざまなクライアント、さらにはドキュメントの自動生成を行うことができます。
Swagger仕様からMarkdownを作成し、Slateでそれらのマークダウンを使用することもできます。 [1]
スレートについて:
-APIドキュメントテンプレート/フレームワーク
- いいね
- 使いやすさ
-構文の強調表示
-言語固有-タブ付き
-ページ検索
-3列のカスタマイズ可能なレイアウト
-テーブルを作成できます
-各ブロック/メソッド/見出しへのスクロール可能なリンク
-アラート機能[3タイプ] –警告、成功、通知
-httpエラーコードの表
-マークダウン構文
-サイトのロゴを使用できます
- デモ
Swaggerについて:
-ドキュメント自体の内部でAPIアクセスを提供し、特定のリクエストに対する応答を確認できます。
-APIがパラメーターとオプションで応答する様子を明確に示します。 -YAMLベースのフォーマット
-ハイパーメディアAPIには適していません
-Swaggerの設計ツールはありません
-応答はXMLまたはJSON形式です
-Swagger JS-ブラウザーまたはnodejsを介してswagger対応のAPIに接続するJavaScriptライブラリー
-Swagger Node Express-node.jsエクスプレスモジュールのSwaggerモジュール
-swagger UIフレームワークがあります
- デモ
Python-flaskに基づいてslate-flask( https://github.com/AhnSeongHyun/slate-flask )を作成します。
特徴:
構成ファイル(config.json):JSON形式に基づいてconfig.jsonを使用してサンプルコードのタイトル、プログラミング言語を設定します。 APIドキュメントとTOC(目次)のパスも設定します。
マルチAPIドキュメントのサポート:オリジナルスレートは、Markdown形式に基づいた1つのAPIドキュメントをサポートします。ただし、スレートフラスコは、TOC(index.json)を使用して効率的な管理とドキュメントの量のためにマルチAPIドキュメントをサポートします。
ドキュメントの動的な変更をサポート:サーバーを再起動せずにAPIドキュメントの変更を反映できます。 Webページの更新時に、存在する場合は、スレートフラスコリロードAPIドキュメントを更新します。ユーザーは、APIドキュメントの作成のみに集中します。