タグ

swaggerに関するtomzzのブックマーク (2)

  • Swaggerを使ってインタラクティブなWeb APIドキュメントをつくる - Qiita

    この記事は、微妙に以下の記事の延長線上です。わかりにくければ、こちらから読んでいただいた方がいいかもしれません。 LittleBitsを使ったIoTをつくり、家の室温変化のグラフをインターネットから見る(前編) - Qiita 「インタラクティブなWeb APIドキュメント」とはどういうものか Swaggerというツールを使います。Web APIYAMLで書いておいて、Swaggerでサーバを立てると、読むだけのドキュメントではなくて、以下のようにパラメータを指定して実際にHTTPリクエストを送ることができるWebページが生成されます。 以下が返ってきたレスポンスです。 以下は実物です。ご自由に動かしてみて下さい。 インタラクティブなWeb APIドキュメント まだちょっと分かりにくいという方のために、アノテーションからドキュメントを作れるswaggerの使い方 - gong023の日記

    Swaggerを使ってインタラクティブなWeb APIドキュメントをつくる - Qiita
  • REST APIを記述せよ!Swagger紹介 #apijp - Groovyラボ

    Web API Advent Calendar 2014、初日はSwaggerを紹介します。 SwaggerはReverbによって開発された、RestfulなAPIを記述する標準仕様です。APIを機械可読な形で記述することは、ドキュメント生成やツール開発、さまざまな形での自動化に非常に重要です。好き嫌いはともかく、SOAPにはWSDLという統一標準がありましたが、RESTには質的にそういった標準がないため、類似するさまざまな仕様が開発されてきました。Swaggerはその中でも最も有望なものの一つだと思います。 1. 特徴 記述はJSONでシンプル。ミニマム定義の例: { "swagger": "2.0", "info": { "version": "1.0.0", "title": "petstore" }, "paths": { "/users": { "get": { "respon

    REST APIを記述せよ!Swagger紹介 #apijp - Groovyラボ
  • 1