ドキュメントツール
最終更新:2020/01/14
CSS
StyleDocco
CSSに適切なコメントを書くことで、CSSのスタイルガイドを自動的に作成することができます。
http://jacobrask.github.io/styledocco/
Kalei Styleguide
http://warpspire.com/kss/
KSS-Node
http://kss-node.github.io/kss-node/
JavaScript
YUIDoc
http://yui.github.io/yuidoc/
JSDoc
http://usejsdoc.org/
Docco
http://ashkenas.com/docco/
Sphinx
PythonプロジェクトのドキュメントをSphinxで作成する
sphinx でドキュメント作成からWeb公開までをやってみた
Sphinxを便利にして、みんなに使ってもらいたい
Windows で Markdown から Sphinx 文書を作る方法のメモ
MarkdownでSphinxできるようになったので試してみた(前編)
MarkdownでSphinxできるようになったので試してみた(後編)
オライリーへの入稿用の Sphinx拡張、sphinxcontrib-getstart-sphinx をリリースしました。
sphinxでpythonのクラスや関数のドキュメントを自動生成する
AutoRest
Azure/autorest
autorestでAPI呼び出しライブラリを生成 with docker
autorestでAPIクライアントの自動生成
go-autorest を使って、Azure の生REST-API をしばき上げる。
ASP.NET Core WebAPI を Swashbuckle でドキュメント作って AutoRest でクライアントを生成
Swagger
Swagger Spec
REST APIに対して Swagger の仕様に準じたドキュメント
Swagger Editer
Swagger Spec の設計書を記載するためのエディタ
Swagger UI
Swagger Spec で記載された設計からドキュメントをHTML形式で自動生成するツール
Swagger Codegen
Swagger Spec で記載された設計からAPIのスタブを自動生成
Swaggerの概要をまとめてみた。
SwaggerでWebAPIドキュメントをExcel仕様書から脱却するアイデア
Swaggerでのapi開発よもやま話
Swagger入門 - 初めてのAPI仕様管理講座【第1回】Swaggerとは
Swaggerとは何か?
Swaggerを使ってインタラクティブなWeb APIドキュメントをつくる
SwaggerでRESTful APIの管理を楽にする
Swagger Editorで作成したファイルをSwagger UIで見てみる
ソースコード内にSwagger用のコメントを書いてHTML形式で生成するツールもあるようです
PHP
LaravelプロジェクトのAPIをswaggerを使ってドキュメント化
Java
swaggerでAPIドキュメントを作ってみる
SwaggerでREST APIドキュメントを生成する
jax-rs – swaggerのアノテーションを使ってSwagger UIにXML / JSONサンプル値を表示する
Swagger UIでAPIドキュメント作成を自動化する
SpringfoxでSwaggerAPI仕様書を自動生成する(環境設定編)
SpringfoxでSwaggerAPI仕様書を自動生成する (詳細設定編:1)
SpringfoxでSwaggerAPI仕様書を自動生成する (詳細設定編:2)
ASP.NET
Swagger Codegen
OpenAPI Generator
AutoRest
Swagger / OpenAPI 定義から C# クライアントを自動生成するツールの比較
Swagger
Swashbuckle と ASP.NET Core の概要
NSwag と ASP.NET Core の概要
ASP.NET CoreでSwaggerを使う
FizzBuzzで、自動テスト、依存性の注入、Swaggerドキュメント 全部やる
ASP.NET Core で作成した Web API のドキュメントを Swagger を使って生成する
Python
Django REST Framework
axnsan12/drf-yasg
Django REST Swagger: deprecated (2019-06-04)
This project is no longer being maintained. Please consider drf-yasg as an alternative/successor. I haven't personally used it, but it looks feature-complete and is actively maintained.
marcgibbons/django-rest-swagger
DjangoRestFrameworkのコードからSwaggerドキュメントを生成しAPI設計を共有
APIドキュメント自動生成ツールdrf-yasgの紹介
Responder
Responderでスキーマ駆動開発: Swagger UIの表示までやってみる
FastAPI
[FastAPI] Python製のASGI Web フレームワーク FastAPIに入門する
API Blueprint
【API Blueprintの使い方】Web APIの仕様書を書く・読む・実行する
API Blueprint で API 仕様書を書いて、配布用の HTML を自動生成する方法
API BlueprintでWeb APIのドキュメントを生成する
API Blueprint を使って Web API の仕様書を書こう
Apiドキュメンテーションツールを使いこなす【api blueprint編】
API Blueprintを使ってドキュメント作成&テストしてみる
API BlueprintでWebAPI仕様書を書く
API Blueprintで仕様書を作ってみた
Copyright© 2005- Naoyuki Sano. All rights reserved.