API設計スキルを次のレベルに引き上げるベストプラクティス22選 - Qiita
本記事は、Mohammad Faisal氏による「22 Best Practices to Take Your API Design Skills to the Next Level」（2021年4月15日公開）の和訳を、著者の許可を得て掲載しているものです。 REST API設計のための実践的アドバイス Photo by Andrea Piacquadio from Pexels はじめに すべてが分かりにくく、ひどいAPIに不満を感じたことはありませんか？私はそうです。 マイクロサービスの世界では、バックエンドAPIの一貫した設計が不可欠です。 今日は、知っておくべきベストプラクティスについて、簡潔に説明します。さあ始めましょう！ 用語 API設計は、リソース指向設計というものに従います。3つの重要な概念で構成されています。 リソース：データの一部（例：ユーザー） コレクション：リソー
JAX-RSでコンテキストの取得 - Qiita
JAX-RSのリソースクラスのメソッドの中で実行環境に関する情報(コンテキスト)を取得できる。何が取得できるかとはJSR-339のSection-9.2に記述してあるもの(Application・UriInfo・HttpHeaders・Requestなど)とサーブレットの場合は10.1に上げられているもの(ServletConfig・ServletContextなど)が取得できる。ただしJAX-RSを使っているときにサーブレットコンテキストに頼るような構成はあまりやらないほうが良いらしい。 具体的な情報は@Contextアノテーションを使って取得する。以下サンプルとテスト。 package example.jaxrs; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.core.Context; impo
JAX-RSでHTTPヘッダを取得する
import javax.ws.rs.GET; import javax.ws.rs.HeaderParam; import javax.ws.rs.Path; import javax.ws.rs.core.Response; @Path("/users") public class UserService { @GET @Path("/get") public Response addUser(@HeaderParam("user-agent") String userAgent) { return Response.status(200) .entity("addUser is called, userAgent : " + userAgent) .build(); } }
はてなブックマーク REST API | Hatena Developer Center
はじめに はてなブックマーク REST API を使うと、はてなブックマークのブックマーク、エントリーなどの情報を取得したり、新規に作成・投稿したりできます。 本ドキュメントに関する注意事項 API の仕様は予告なく変更される可能性があります。 過剰な連続アクセス、 User-Agent を正しく指定しないアクセスなどは予告なしに制限をかける場合があります。 バージョン 2013年8月、バージョン1が提供されました。 認証 本 API は OAuth によるユーザー認証に対応しています。OAuth 認証の詳細に関しては、はてなサービスにおける OAuth を参照してください。 提供するフォーマット JSON 形式をサポートしております。各 API の出力の例をご覧ください。 ブックマーク API 名前実行する操作
SpringのRestTemplateが便利すぎて鼻血でた - Qiita
元々はC#、最近はNode.jsがコーディングの主流だったのですが、仕事で久々にJavaを使うことになりました。Javaは10年以上前にJava AppletからJNIでPCの周辺機器を操作するようなものを作って以来です。ServletとかTomcatとかStrutsとかとは無縁に生きてきました。 というわけで、久々にJavaを使って見たら、Spring 3.0～ にRestTemplateとかいう余りに素敵なクラスがあって驚いて鼻血が出たので、驚きを記事にしてみました。 RestTemplateの何がすごいかというと、Rest APIを呼び出すのに1行だけで済んでしまうという点です。これまでなら、HttpConnectionをOpenして、そこからBufferedWriterで書き出して、ResponseをBufferedReaderで読み込んで、みたいなことをしていましたが、そんな複雑
Jersey Client API : Java でWeb API Client を作成する方法 | TECHSCORE BLOG | TECHSCORE BLOG
私たちはシステムをサブシステム・マイクロサービスに分割する方針を採用しているので、サブシステム間の通信、Web API を呼び出す処理を開発することが多くあります。このような処理をJavaで開発する場合、何をつかってどう書いたらいいでしょうか。この記事では、弊社シナジーマーケティングのプロダクト開発のスタンダードな方法をご紹介します。 目次 Jerseyとは クライアントの作成 GETメソッドの実行 POSTメソッドの実行 HTTPヘッダーの指定 JSONのパース Jerseyとは ライブラリは Jersey を利用しています。Jersey ( https://jersey.java.net/) は、RESTful Web サービスとそのクライアントのJava API 標準規格であるJAX-RS API (http://jax-rs-spec.java.net/) のリファレンス実装です。
JAX-RS（Jersey）を使って RESTful API を実装してみよう【導入編】｜NEWS｜株式会社INDETAIL（インディテール）
はじめに 最近では、開発の現場で RESTful API を実装する機会が増えてきました。サーバー環境も含めてサクッと作りたい！という時には PHP・Node.js などが候補に上がりそうですが、実は Java でも簡単に作ることができます。 技術仕様としては、Java EE 6 から追加された「JAX-RS」という Java API 仕様を用います。JAX-RS は RESTful API の開発に特化しており、その実装として Jersey（リファレンス実装）や Apache CXF などがあります。 導入編では Jersey のサンプルコードの実行環境構築と、コードの簡単な説明をします。次回、サンプルコードを応用した RESTful API を実装してみます。 環境構築 Jersey のサンプルコード実行にあたって、公式サイトを参考に環境構築していきます。 https://jersey
DRFのGeneric viewの使い方 - Qiita
を押されておけば大丈夫かと。 他のクラスは、上記クラスを組み合わせたクラスになります。 HTTPのリクエスト メソッドで役割を切り替えます。 ListCreateAPIView （POST、GET） = ListAPIView + CreateAPIView RetrieveUpdateAPIView（GET、PUT、PATCH） = RetrieveAPIView + UpdateAPIView RetrieveDestroyAPIView（GET、DELETE） = RetrieveAPIView + RetrieveDestroyAPIView RetrieveUpdateDestroyAPIView（GET、PUT、PATCH） = RetrieveAPIView + UpdateAPIView + DestroyAPIView 実装 ざっくり書くと、どのクラスを使う場合も、
アプリ開発の流れを変える「GraphQL」はRESTとどう違うのか比較してみた
注：単純なデータモデルでさえ、今後の維持や説明が必要になる6つものエンドポイントが含まれています。 あなたがクライアント側の開発者で、movies APIを使い、HTMLとjQueryで単純なWebページを作るとします。そのためには、映画と出演俳優・女優の情報が必要です。APIに必要な機能は揃っているので、データを取得します。 新しくターミナルを開いて以下を実行します。 curl localhost:3000/movies 以下の応答が返ってきます。 [ { "href": "http://localhost:3000/movie/1" }, { "href": "http://localhost:3000/movie/2" }, { "href": "http://localhost:3000/movie/3" }, { "href": "http://localhost:3000/mo
Django REST frameworkについての雑記 - Qiita
Django REST frameworkでスマホアプリ用のWebAPIを作ったときのメモ書きなど。 トークンを使用した認証処理について 最初にユーザIDとパスワードで認証を行ったときにトークンを発行して、以降はそのトークンをリクエストに含める形式にしたかったので、以下のように実装した(DjangoのUserテーブルとかをそのまま使用する)。 ユーザ情報の新規登録処理 ユーザ情報をUserテーブルに登録する際、パスワードだけDjangoのライブラリを使用してハッシュをかけて登録するようにした。 https://docs.djangoproject.com/en/1.8/_modules/django/contrib/auth/hashers/#make_password class UserSerializer(serializers.HyperlinkedModelSerializer)
REST APIを利用して、JIRAのサマリーを外部エディタで編集してみよう！――外部ツール連携の第一歩
はじめに 今回は、JIRA課題のサマリー（要約）を外部エディタ上で編集してJIRAに書き戻す機能を、JIRAのREST APIとElectron上に構築したテキストエディタを連携させ、実現していきます。 通常、JIRAのテキストフィールドで一括置換を行いたい場合、CSV Export/Importを使って外部ツール経由で行うなど一手間が必要です。そこで、テキストエディタとREST APIを用いて直接連携すると、便利なテキスト編集機能を使いながら手軽に要約の一括置換ができるようになります。 実装はJavaScriptとjQueryを組み合わせて行います。 サマリーエディタのイメージ 必要な環境 Electron稼働環境（本記事ではv1.6.2を利用しました） macOS 10.9以降, Windows 7以降 JIRA6.4以降（サーバ版のみ） サマリーエディタを動作させてみる はじめに、必
LoopBack - Node.js framework
A Brand New Core A brand new LoopBack core to deliver great extensibility and flexibility written in TypeScript/ES2017. OpenAPI Spec Driven REST API Create powerful APIs easily with a new creation experience for defining REST API's and handling API requests/responses. Unbelievably Extensible A new, improved programming model with Dependency Injection and new concepts such as Components, Mixins, Re
RaspberryPi3とhomekitとwebIOPiで家電操作する - Qiita
はじめに RaspberryPi3を使ってIR信号(赤外線信号)を送信して家電を制御するためにしたことをメモ。 本当はIRKitがあれば簡単にできる(記事)。しかし現在買現在買うことができず、後継機はあるようだがすぐには手に入れることができなさそうなので、、ラズパイのGPIOからIR送信する。（こっちは低コストですから (´；ω；｀)ﾌﾞﾜｯ やりたいことはスマホやPCからラズパイにIR送信のリクエストを送り、GPIOからIR送信することで家電を制御できるようにする。 必要なもの 最低限必要なものは、ラズパイ・赤外線受信モジュール・赤外線LED。 一応、赤外線送信を強くするためトランジスタを使った回路にしているが、受光器に直接向けるのならば問題ないと思う。ただ、エアコンや照明のような少し距離があるものだと、シンプルな回路だと光量が弱く届かないかもしれないので注意が必要。 構成とリクエストに
Django REST Frameworkを使って爆速でAPIを実装する - Qiita
この記事は「Python その2」Advent Calendar 2015の14日目です。 何を書こうか迷ってましたが、今年学んだPython関係の技術で一番恩恵を預かったREST Frameworkについて書いてみようと思います。 はじめに APIを作るのは結構面倒 初めにAPIを作るということの難易度に触れておこうと思います。 実際に作った経験のある方も多いと思いますが、WebAPIはWebページと違ってロジックのみに集中して開発できるので、開発しやすいといえば開発しやすいです。デザインや利用環境気にしたり、HTMLやJavascriptような複数の言語を駆使する必要も全く無いです。レスポンスを正しく受け取って適切にレスポンスを返すだけ。 とはいうものの実際作ってみると面倒な事が多く出てきます。例えば入力された値が正しいのかどうかをチェックしたりだとか、複数の条件で結果をフィルタリング
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Content Negotiation in a REST API
@BeanParam | RESTful Java with JAX-RS 2.0 (Second Edition)
https://www.web-development-kb-ja.site/ja/java/jersey-get%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%81%A7%E8%A4%87%E6%95%B0%E3%81%AE%E3%82%AF%E3%82%A8%E3%83%AA%E3%83%91%E3%83%A9%E3%83%A1%E3%83%BC%E3%82%BF%E3%83%BC%E3%82%92bean%E3%81%AE%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AB%E3%83%9E%E3%83%83%E3%83%97%E3%81%99%E3%82%8B%E3%81%AB%E3%81%AF%E3%81%A9%E3%81%86%E3%81%99%E3%82%8C%E3%81%B0%E3%82%88%E3%81%84%E3%81%A7%E3%81%99%E3%81%8B%EF%BC%9F/971356962/
はてブAPIでwebサービスを作りたい全ての人に向けて書きました
Leveraging Django Rest Framework and generic views for rapid API development
Node.js+Express+MongoDBでREST APIをつくる - Qiita
