LaravelにSwaggerでAPIドキュメントを一つ書く（1/2) - QiitaDeleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article?
Play FrameworkでSwaggerを使う - Qiita
SwaggerはJSON API用のドキュメンテーション作成ツールです。 http://swagger.io/ http://petstore.swagger.wordnik.com/ こんな画面が生成されて、画面の下の方にある"Try it out"というボタンで実際にリクエストを送信することができます。 SwaggerとPlay Framework 上の画面はSwagger UIというHTML+JavaScriptのツールによるもので、Swaggerの実体はコードアノテーションを解釈してエンドポイントに関するJSONを返してくれるツールです。 SwaggerのメインリポジトリであるSwagger CoreはScalaで書かれていて、Play Frameworkの用ライブラリもSwagger Coreのリポジトリ内にあります。 Play FramworkでSwaggerを使うサンプルアプ
Swaggerを使ってインタラクティブなWeb APIドキュメントをつくる - Qiita
この記事は、微妙に以下の記事の延長線上です。わかりにくければ、こちらから読んでいただいた方がいいかもしれません。 LittleBitsを使ったIoTをつくり、家の室温変化のグラフをインターネットから見る（前編） - Qiita 「インタラクティブなWeb APIドキュメント」とはどういうものか Swaggerというツールを使います。Web APIをYAMLで書いておいて、Swaggerでサーバを立てると、読むだけのドキュメントではなくて、以下のようにパラメータを指定して実際にHTTPリクエストを送ることができるWebページが生成されます。 以下が返ってきたレスポンスです。 以下は実物です。ご自由に動かしてみて下さい。 インタラクティブなWeb APIドキュメント まだちょっと分かりにくいという方のために、アノテーションからドキュメントを作れるswaggerの使い方 - gong023の日記
swagger-expressを使って簡単にAPIドキュメントを作成する - Qiita
APIドキュメントツールにswaggerというものがあります。 公式のデモ ドキュメントに記載したAPIの一覧を表示し パラメータなどを直接入力してその場で試せるというものです。 facebookのGraph API Explorerや twitterの https://dev.twitter.com/console と同じような位置づけです。 すべて設定するととても便利なのですが、 ドキュメント元となるJSONの作成が必要であったり、 使いこなすのが結構大変だったりします。 ただswagger-expressを使うと 出来るだけ簡単にドキュメント化することができます。 swaggerの構成 ブラウザでの表示のためのindex.htmlやjs,css,imgなどがある、swagger-ui APIの情報がまとめられている 設置の仕方 expressを使ったアプリ sampleApp 上で、
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
LaravelプロジェクトのAPIをswaggerを使ってドキュメント化 - Qiita
