認証を含む API 開発で検討すべきこと - ボクココ
ども、@kimihomです。 API に関する基礎的な話で、なぜ API が重要なのか、APIの実装で注意する点について記述した。 今回はAPI開発において最も頭を悩ます、認証の問題について考えてみたい。 API における認証 よくあるログインが必要なページを考えてみていただきたい。 通常のWebアプリケーションであれば、Cookieという仕組みを使って毎回Webサーバーにアクセスするときにsession idというものを送信し、それとユーザー情報を紐付けたデータを取ってくることで、どんなユーザーからリクエストが来たのかをWebアプリケーション側で判断することができる。これにより、私たちはいつも閲覧しているWebアプリケーションが自分専用の画面として見れるようになっている。 これがAPIになると話は違ってくる。Cookieという仕組みが使えないのである。ということで、なんとかしてAPIにア
シンプルさとパフォーマンスを両立した API 設計と実装の一例 - HeartRails Tech Blog
こんにちは、エンジニアの村田です。今回はシンプルさとパフォーマンスを両立した API を作るためにはどうすればよいのかについて述べていきます。 背景 いままで API サーバーを作ってきて、シンプルな API にすればパフォーマンスが犠牲に、パフォーマンスを優先すれば実装が複雑になって保守が大変になるということを経験してきました。具体的には、 関連リソースの Entity が何重にもネストしていたり、同じリソースに一覧用、詳細用などの Entity があり実装、保守が大変 1. の問題を解消するためにシンプルな API にする 2. では N+1 の問題がありパフォーマンスが悪い 1. 2. の問題を解消するためにリソースの Entity はシンプルにしつつ、パラメーターで関連リソースを指定すると関連リソースの Entity を埋め込んで返すようにする 4. だと関連リソースの権限管理やペ
Cognitoから払い出されたIdTokenをAPI Gateway カスタムオーソライザーのLambda(Python3.6)で検証する方法 | DevelopersIO
Cognitoから払い出されたIdTokenをAPI Gateway カスタムオーソライザーのLambda(Python3.6)で検証する方法 おつかれさまです。サーバーレス開発部の新井です。 今回はタイトル通り、Cognitoのユーザプールから払いだされたIdTokenをAPI GatewayのカスタムオーソライザーのLambda(Python3.6)で検証する方法を紹介したいと思います。 API GatewayのカスタムオーソライザーでIdTokenの検証を行うには、Cognitoの自動チェックと、今回紹介するLambda Functionでチェックする２種類の方法があります。 Lambda Functionを利用する場合のメリットは、IdTokenの検証以外の認可処理を行うことができるという点です。例えば、IP制限や特定のユーザエージェントだけ許可するなど、用途に応じた処理を書くこと
Amazon API Gateway で Custom Authorization を使ってクライアントの認可を行う | DevelopersIO
Custom Authorization とは 2016年2月11日に Amazon API Gateway (以下 API Gateway) の新機能「Custom Authorization *1」がリリースされました。 Introducing custom authorizers in Amazon API Gateway | AWS Compute Blog Custom Authorization を使うと、 API にアクセスしてきたクライアントに対する認可の機能を組み込むことができるようになります。弊社内でも要望の多かった機能なので、このアップデートは喜ばしい限りです！ 本ブログでは Custom Authorization を使うとどのような流れで認可が行えるのか、その仕組みを解説します。 認証と認可 Custom Authorization を理解するためには、そもそも「
SwaggerでRESTful APIの管理を楽にする - Qiita
背景 最近は変化し続ける要件に対応するために、システムも柔軟であることが求められています。 そのため、部分的に変更やスケールの可能なシステムを構築し、API経由で連携するマイクロサービス的アーキテクチャが増えてきています。 そういった設計の中で問題になっていくのが、従来のモノリシックなアプリケーションではIDEやコンパイラなどで行っていた、機能間のインターフェイスをどう管理するかという部分です。 Swaggerとは? SwaggerとはRESTful APIのドキュメントや、サーバ、クライアントコード、エディタ、またそれらを扱うための仕様などを提供するフレームワークです。 公式サイトでは、The World's Most Popular Framework for APIsと謳っています。 その理由は、マイクロソフト、Google、IBM、SmartBearなどを大手の企業を含む「Open
Google Cloud Vison APIでNDLのデジコレ画像をひたすらOCRをかけてみる（その1） | kzakza
Google Cloud Vison APIで 光学式文字認識（OCR）をかけたり、画像に含まれているものの解析ができるようになっていますので、以下で公開されている方法とスクリプトで国立国会図書館デジタルコレクションで公開されている画像データをOCRにかけてみました、のその１（気が向けば、いろいろと試してみたいので、引き続きやってみるつもり）。 ※2017/8/19 追記 このエントリでは、レイアウトの認識に難ありという話になってしまいましたが、レイアントを認識できる方法で改めて同じ画像をGoogleのOCRにかけたものを以下に紹介しています。 Google Cloud Vison APIでNDLのデジコレ画像をひたすらOCRをかけてみる（その1 再戦） 正確すぎる！Googleの画像認識APIで超ラクラクOCR（macOS・ていねい解説） : GOROLIB DESIGN – はやさはち
安全で便利な Webhook を作る
安全で便利な Webhook を作る Tweet Webhook をご存知でしょうか。GitHub やその他のサービスで提供されているあの機能です。 今回は弊社の Komoju API で Webhook を提供する際に気づいた、webhook 実装上の注意点について書きます。 内部のサーバーへのアクセスを禁止する 一般的な Webhook はユーザーが送信先となる任意のURLを指定して、サービスはそこに対してPOSTリクエストを送信します。 このときに気をつけないといけないのは「そのURLがサービス内部のホストかどうか」を識別しなければならないということです。 たとえば localhost とか、内部 DNS のドメインとかです。このような宛先への Webhook 送信を許可してしまうと、本来は外部から隔離されてアクセスできないはずのサーバーに Webhook送信サーバー経由でアクセスで
Creating a WordPress Theme using the REST API and Vue.js
After attending the Day of REST conference a couple of weeks ago I was inspired to dive in to the WordPress REST API and test it out. On the day Jack Lenox from Automattic gave a talk entitled “There and Back Again: A Developer’s Tale” in which he described his experience building a WordPress theme using the REST API and React. His insights were interesting and he clearly spelled out some of the c
リクルートテクノロジーズのAIプロジェクト「A3RT（アート）」が始動、機械学習、ディープラーニングの6APIを公開 | Biz/Zine
株式会社リクルートテクノロジーズは、機械学習やディープラーニングを用いたソリューションAPI群「A3RT(アート)」を無料公開した。これまではリクルートグループ内に限定して展開したAPIを、外部に無料公開することで、多くのフィードバックを得ることで精度を向上させることが目的。リスト生成、文書分類、文章校正や対話など6種類を公開。順次拡大予定だという。 リスト生成、文章構成、画像分類など6API A3RT（アート）は「ANALYTICS & ARTIFICIAL INTELLIGENCE API VIA RECRUIT TECHNOLOGIES」の略称。今回、無料公開をするAPIは下記6種類となる。 ■Listing API リスト生成用API。ユーザーの行動ログをもとにアイテム間の相関リストや各ユーザーへのレコメンドリストなどを生成することが出来る。 ■Image Infuluence A
Codenberg コーデンベルク｜印刷物の注文から発送までを自動化
印刷物の注文から発送までを自動化 企業の顧客管理システムとAPI連携しデータ管理や入稿などの業務負荷を削減 顧客ごとに内容を変えるパーソナライズ印刷にも対応 資料請求・お問い合わせ “共感を生む顧客体験価値をITの力で自動･最適化する” コーデンベルクは、企業のシステムや顧客管理ツールと印刷を連携させることで これまでにないサービスを創り出すデジタル印刷プラットフォームです 企業の様々なニーズに柔軟に応え、商用品質の印刷物の自動化を実現するAPIと 注文や製造をモニタリングするウェブサービスで成り立っています（特許第6163233号） 顧客開拓・優良顧客育成に最適一人ひとりに最適なメッセージと タイミングで自動発送 独自の組版・面付システムにより、パーソナライズ印刷、バリアブル印刷(可変印刷)に対応しています。宛名だけでなく、画像、テキスト、QRコードなど1枚づつ個別にカスタマイズし、顧客
HTTP APIの詳細なエラー情報をレスポンスに持たせるための仕様
今日では HTTP(s) で API が公開されることは当たり前の時代ですが、エラーをアプリケーションにどう伝えるかは、個々の API の設計に依存していました。特に、HTTP ステータスコードは有限であり、元々持っている意味があるので、自由に使うことはできません。API はそのドメインごとにもっと複雑で細かなエラー情報があるはずで、それらはレスポンスボディに載せてアプリケーションに伝えることになりますが、その書式に規定は今までありませんでした。 HTTP API にて、アプリケーションにエラー情報を伝達するための（レスポンスボディに載せられる）標準的な形式が、RFC7807 Problem Details for HTTP APIs で定められています。適用例としては、以下のようになります。 HTTP/1.1 403 Forbidden Content-Type: application
RESTful APIの記述標準化を目指す「Open API Initiative」をマイクロソフト、Google、IBMらが立ち上げ。Swaggerをベースに
RESTful APIの記述標準化を目指す「Open API Initiative」をマイクロソフト、Google、IBMらが立ち上げ。Swaggerをベースに 10年以上前、XMLの登場に続いてXMLベースのAPIを記述する標準フォーマット「WSDL」が提唱されました。 WSDLにはAPIの仕様がマシンリーダブルな形で記述されており、APIを呼び出すためのプロトコルやデータフォーマットをあらかじめ知ることができます。WSDLを利用することで、APIをコールするためのコードを自動生成することが可能でした。 しかしXMLベースのAPIは期待されたほど普及せず、現在ではよりシンプルなRESTful APIが事実上の標準となっています。 そしてRESTful APIのためのWSDLとも言うべき、RESTful APIのインターフェイスを記述するための標準フォーマットを推進する団体「Open AP
RedPen による文書検査用 REST API | Advanced Technology Lab
ATL の伊藤（takahi_i）です。 前回 RedPen をご紹介した時にはバージョンが 0.6 でした。その後大きな改良が加えられ、 現在のバージョンは 1.2 となっています。 本稿では RedPen のサーバについて機能について解説します。 当時 RedPen はコマンドラインで利用のみを想定していましたが、現在ではサーバ機能の開発に多くの力を注いでいます。 RedPen サーバは Web UI だけでなく、REST API も提供します。RedPen の REST API を使うことでユーザは RedPen をローカルの環境にインストールすることなく文書検査をおこなえます。 RedPen サーバ API の特徴の一つには、柔軟な設定があります。 つまりユーザは文書の検査を自分の規約（設定ファイル）にあわせておこなえます。 さらに今回解説する RedPen サーバは、 Herok
WebAPIリクエスト仕様書としてcurlコマンドのご提案 - Qiita
WebAPIの仕様を記述する方法はいくつかあると思う。 普通に日本語で記述する JSON Hyper-Schema、WADL、RAML、Swaggerなどを使う 仕様書の代わりにプログラムを書く HTTPメッセージそのものを記述しておく でも、文法にばらつきがあったり、読みにくかったり、ツールのセットアップが面倒だったり、どれもイマイチな所があって、手軽な方法が欲しいと思っていた。 何気なくcurlコマンドのオプションを調べていたら、「もうこれでAPIドキュメント扱いにしちゃえばいいんじゃね？」と思えてきたのでメモしておく。 curlコマンドのおさらい curlコマンドはlibcurlの付属コマンドで、最近のUnix系OSなら大抵最初から入っていると思う。コマンドの詳細はmanを読んでいただければ。 cURL - How To Use （マニュアルページ日本語訳） curlコマンドのオプシ
[Apiary]Markdownで始めるAPI開発とAPIドキュメント作成 | DevelopersIO
APIを作るとき みなさん、毎日API使ってますか？私は、ワンライナーでAPIをコールすることにハマっています。さて、いつも使っているAPIを作る側になったとき、どのように設計していますでしょうか？また、作ったAPIをどのように使ってもらっていますか？そんな疑問に応えるサービスがApiaryです。 Apiaryとは？ Apiaryは、REST APIをサクッと書けるサービスです。また、APIドキュメントも生成してくれます。モックサーバも提供してくれます。API利用サンプルコードも作ってくれます。うん、使わないって選択肢は無いですねｗ。 無料登録すると早速使えるようになります。チームでプライベートなAPI開発をしたければ有料プランを選択してください。 API開発の流れ API開発の流れは、まずはじめにMarkdown形式でドキュメントを書きます。既にサンプルがあるのでこれを使ってみましょう。
![[Apiary]Markdownで始めるAPI開発とAPIドキュメント作成 | DevelopersIO](https://cdn-ak-scissors.b.st-hatena.com/image/square/60d7120d91185f1739fec5fcbd006f066b98e9f6/height=288;version=1;width=512/https%3A%2F%2Fdevio2023-media.developers.io%2Fwp-content%2Fuploads%2F2015%2F02%2Fapiary-logo.png){kind=logo}
開発者の皆さまへ | developer.5ch.net
5ch.net 専用ブラウザの開発者の皆さまへ 5ch.net 専用ブラウザ（以下「専用ブラウザ」）を開発、公開するには、5ch.net の所有者である Loki Technology, Inc. の許諾を得て、5ch.net が提供する API（以下「API」）を用いる必要があります。 ウェブスクレイピングを用いた専用ブラウザの開発、公開は禁止されています。 API の使用許諾を得ずに API を使用することは、不正アクセス行為の禁止等に関する法律等関係する法律に違反することになります。違法行為を発見次第、刑事民事による適切な法的対応をされることになります。 株式会社ジェーンは Loki Technology, Inc. から API の使用許諾を得て、一部の専用ブラウザ開発者に対し、API を使用許諾する権限を受けていますが新規の登録は受け付けておりません。 株式会社ジェーンは Lok
Web APIを作るときに考えること。 - パルカワ2
この記事はPepabo Advent Calendar 2014の11日目の記事です。 前日は、tnmtさんのVagrantのshell provisionerでApacheのビルド済tarボールをOSバージョン毎に作る術でした。 はじめに 今回は、Web APIを作るときに考えることをまとめました。 本当は、社内向けに資料を作っていて、社内の勉強会とかで話せればいいか〜って考えていたんですが、アドベントカレンダーのネタが本当になくて困っていたのでこれを使います。 対象者 APIを作る時、と書いてますが、クライアント側の人にとっても知っておく必要があることなので、サーバ側の人・クライアント側の人両方が対象者です。 APIを作るときに考えること 「APIを作るとき」と言っても、色んな状況があります。 まずはそれを絞ります。 APIの種類 プライベートAPI アプリのAPIなど使う人が限定され
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
まだAPI定義管理で消耗してるの？〜Swaggerを用いた大規模アプリ時代のAPI定義管理とコードジェネレート〜
dfltweb1.onamae.com – このドメインはお名前.comで取得されています。
WebHookの調査と実装
