web-dev-qa-db-ja.com

郵便集配人コレクションからHTMLドキュメントを作成する

私はかなり拡張APIを開発しましたが、Postmanでそれを使用しています。次に、ソースと一緒に/ docs内でバージョン管理するHTMLドキュメントを生成する必要があります。

これを実現するツールや方法はありますか?このドキュメントをすべて書きたくありません。郵便配達員のコレクションを共有することはオプションではありません。

22
danielrvt

私は最近同じ問題を抱えていて、何も見つかりませんでした。そこで、それを行う簡単なツールを作成しました。 react.jsで書かれた非常に基本的なjavascriptアプリケーションです。現時点では非常に基本的なものですが、現在取り組んでいるので、機能のリクエストは大歓迎です。

以下で無料で使用できます: http://www.vernizzis.it/docman/

さらに、コードを取得して変更することができます: https://github.com/davidevernizzi/docman

コメントは大歓迎です。

更新1:周りを見て、私もこのプロジェクトを見つけました: https://github.com/JakeWorrell/docodile およびこの機能要求: https://github.com/a85/POSTMan-Chrome -Extension/issues/204

UPDATE2:機能要求(UPDATE1を参照)は終了し、ドキュメントを作成する可能性がPostmanクラウドに追加されました。機能リクエストの終了コメントは次のとおりです。

これはPostman Cloudの一部として利用可能です: http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/ 。クラウドは、すべてのユーザー向けのドキュメントをホスト、更新、および保守します。コレクションから1回限りのドキュメントを生成するには http://docman.launchrock.com/ および https://github.com/JakeWorrell/docodile をお勧めします。

30
Davide Vernizzi

これは古い質問であり、おそらく今までに解決策を見つけたと思いますが、それでもPostmaneratorに興味があるかもしれません: https://github.com/aubm/postmanerator

基本的に、これはコマンドラインから使用する方法です:

postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html

インストールするには、最新のGithubリリースをダウンロードしてください。システムに応じて適切なバイナリを選択する必要があります。次に、PATHのどこかに配置します。

追加情報が必要な場合は、READMEのドキュメントを参照してください。そこから、ツールを最大限に活用するための推奨事項を見つけるか、カスタムテーマを使用してドキュメントの外観を変更します。

Githubプレゼンテーションは、生成されたサンプルドキュメントへの参照も提供します。

また、TravisなどのCIプラットフォームを活用して、Postmaneratorを使用してドキュメントの生成と公開を自動化する方法についても説明します。

これは私が現在取り組んでいるオープンソースプロジェクトですので、それを改善できるアイデアがあれば、Githubに問題を投稿してください。

19
kendo5731