motoyasu-saburi / api-document-example

APIドキュメントの説明用

ファイル説明

api-blueprint, raml, swaggerフォルダに関しては、 それぞれ同じ題材を元に作成したドキュメント例がまとめてあります。

demoフォルダに関しては、 API Blueprint形式で書いたドキュメントと、 そのドキュメントを元にMock Serverを立てるツール、テストを行うツール ドキュメントのビュワーがまとめてあります。 起動方法についてはdemoフォルダのREADMEを参照してください。