タグ

Web APIに関するsnjxのブックマーク (3)

  • HTMLでWeb APIをつくる - Qiita

    シングルページアプリケーションやモバイルアプリなどの普及により、サーバサイドではJSONを出力するWeb APIの必要性が高くなってきています。みなさんはどのようにWeb APIを作っているでしょうか。 JSONはビュー RailsでJSON APIを定義する時、素のままでやろうとすると コントーラでto_jsonを呼んだり、モデルにas_jsonを定義したりすることになるかと思います。 モデルに書くとAPIによって出力内容を変えたい場合にとても苦労します。 API数が増えれば増えるほどモデルが複雑になっていきます。 APIレスポンスとしてのJSONはコントローラやモデルに書くべきでしょうか? ビューに書いた方が自然ではないでしょうか? これはRailsでの話ですが、Railsに限らず、フレームワークを使ってWeb APIを作るときに一般的にあてはまることだと思います。 変化に強い、再利用

    HTMLでWeb APIをつくる - Qiita
  • Web APIにはJSONベースのフォーマットを使おう - Qiita

    { "response": { "id": 3342124, "message": "Hi!", "user": { "id": 3456, "name": "Taro Yamada", "image_url": "/images/taro.png" } } } など、どの構造がいいでしょうか? もっと違う構造も考えられます。 JSONはシンプルですが、構造に制約がなさすぎます。適切な設計を行うには適切な制約が必要です。 そこで、plain JSONに少し制約を加えたJSONベースのフォーマットを使うことをおすすめします。 もしあなたが、JSONレスポンスをどのようなフォーマットにするかをチームで議論したことがあるなら、JSON APIは『自転車置き場の議論』に対抗する武器となる。 共有された規約に従うことで、生産性が向上し、汎用的なツールを利用でき、アプリケーションという重要なものに集中

    Web APIにはJSONベースのフォーマットを使おう - Qiita
  • Swagger Editor - Swaggerフォーマットの編集とコード生成

    MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました SwaggerはWeb APIの標準記述フォーマットとして知られつつあります。標準ができるということは、それを使っていれば同じデータを使って他のフォーマットやサービスで使うことができるようになります。 すでにコード生成ライブラリなどが作られていますが、今回はSwagger向けのドキュメントを作れるSwagger Editorを紹介します。 Swagger Editorの使い方 こちらがメイン画面です。左側がエディタ、右側にその結果が表示されます。 イチから記述する他、JSONを貼り付けて読み込ませることもできます。 設定が多数用意されています。 クライアントやサーバサイドのコード生成が行えます。その結果はZipファイルでダウンロードできます。 例えばRubyのコードはこのようになり

    Swagger Editor - Swaggerフォーマットの編集とコード生成
  • 1