30 Oct '16, 3pm

RailsのAPIをswaggerでドキュメント化してみる [Ruby] on @Qiita https://t.co/WcQ6waIzSl

RailsのAPIをswaggerでドキュメント化してみる [Ruby] on @Qiita https://t.co/WcQ6waIzSl

最近Railsを使用してAPIを作成することが多いのですが、静的にドキュメントにリクエストパラメータが〇〇で、レスポンスが□□で...の用に書くのがたるくなってきたので、何か良いツールが無いかと探していた所、`Swagger`というツールを見つけました。 ## Swaggerについて [公式サイト](http://swagger.io) APIのパス、説明、リクエストパラメータ、レスポンス等を記述したJSONファイルを、Swaggerを使用することで、Web上で、インタラクティブにRestfulAPIの動作確認も行えるOSSです。 ![swagger.png](https://qiita-image-store.s3.amazonaws.com/0/20424/a30e6bfc-b95d-b9bf-cfcf-e1f78e828773.png) 現行バージョンは2.0で、こちらについては、Web上でymlを記載するだけで生成してくれるエディターが存在します。 http://editor.swagger.io#/ ## Railsで作成したAPIに対してSwaggerを使用する RailsでSwaggerのJSONを生成する場合、いくつかの方法があります。 - `grape-swagger`というgemでgrapeの記法で使用する - `swagger-docs`というgemでRailsのコントローラ、ルーティングを動的にJSONにパースする(しかし1.2しか対応していない) - `ruby-swagger`というgemで頑張る(多分これを使うくらいなら上記のエディタの方が楽) それで、今回は既存のRailsのRestfulAPIに対してドキュメントを記載したかったため、`swagger-docs`を採用しました。 ## swagger-docs ### インストール Gemfileに以下を追記します ```ruby:Gemfile # grapeは使用しないが、中にswagger-uiのassets一式が入っているので、viewに利用 gem...

Full article: http://qiita.com/kitaro_tn/items/ace80a36ac3cfc060788

Tweets

(33 ストック) 意外と知らないかもしれないRuby, Railsのメソッドとか https...

qiita.com 29 Oct '16, 4am

# はじめに Railsを使ってコードを書いていると、「どんなメソッドが使えるんだっけ?」 「もっと便利なメソッドないのか?」と思うことがあると思います。 そんな時に、私がよく使うのが`Object.methods`や、特定のメソッドを探す`O...