エントリーの編集
エントリーの編集は全ユーザーに共通の機能です。
必ずガイドラインを一読の上ご利用ください。
シャレオツなAPIドキュメントページを作ろう | FAIRWAY Engineer {Blog}
記事へのコメント0件
- 注目コメント
- 新着コメント
このエントリーにコメントしてみましょう。
注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています
- バナー広告なし
- ミュート機能あり
- ダークモード搭載
関連記事
シャレオツなAPIドキュメントページを作ろう | FAIRWAY Engineer {Blog}
ギロッポンよりこんにちは、ニタです。 今回はWebAPI向けのドキュメントジェネレーター「apiDoc」を紹介... ギロッポンよりこんにちは、ニタです。 今回はWebAPI向けのドキュメントジェネレーター「apiDoc」を紹介します。 ドキュメントジェネレーターといえば、ApiGenやDoxygen、phpDocumenterなどありますが、それらはクラス内メソッドについてのドキュメントであり、外部向けのドキュメントとしては不要な内容も記載されてしまいます。 RESTfulなAPIドキュメントとしてはちょっとドキュメントとしての意味合いが違います。 サンプルを見ていただくとわかると思いますが、apiDocは独自記法ではありますが、生成されたドキュメントの見易さとしては他のドキュメントジェネレーターより上だと思います。 ※先日、弊社のサービス「extorage」のAPIが公開されましたが、そちらのドキュメントページの生成でも使用しています。 インストール npmよりインストールしますので、予めインストール

