タグ

2016年10月31日のブックマーク (1件)

  • RailsのAPIをswaggerでドキュメント化してみる - Qiita

    最近Railsを使用してAPIを作成することが多いのですが、静的にドキュメントにリクエストパラメータが〇〇で、レスポンスが□□で...の用に書くのがたるくなってきたので、何か良いツールが無いかと探していた所、Swaggerというツールを見つけました。 Swaggerについて 公式サイト APIのパス、説明、リクエストパラメータ、レスポンス等を記述したJSONファイルを、Swaggerを使用することで、Web上で、インタラクティブにRestfulAPIの動作確認も行えるOSSです。 現行バージョンは2.0で、こちらについては、Web上でymlを記載するだけで生成してくれるエディターが存在します。 Railsで作成したAPIに対してSwaggerを使用する RailsでSwaggerのJSONを生成する場合、いくつかの方法があります。 grape-swaggerというgemでgrapeの記法で

    RailsのAPIをswaggerでドキュメント化してみる - Qiita