RESTful のウェブ API 設計で避けるべき 6 つのよくあるミス | Google Cloud 公式ブログ
※この投稿は米国時間 2022 年 12 月 1 日に、Google Cloud blog に投稿されたものの抄訳です。 オンラインで、組み立て式のテーブルを注文したとします。ところが、パッケージを開けてみると、組立説明書が入っていません。完成品がどんなものかはわかっていても、それぞれのパーツをどう組み立てればいいのか、まるでわかりません。設計が不十分な API を使うコンシューマ開発者も、同じような経験をしているといえます。適切に設計された API なら、容易に見つけ、検索してアクセスし、使用することができます。高品質の API は、コンシューマ開発者がアイデアをひらめき、新しいユースケースを作り上げる手助けになってさえくれます。 もちろん、API 設計を改善する方法はあります。たとえば、RESTful のプラクティスに従うなどです。しかし、お客様が知らず知らずのうちに、ちょっとした不便
ケンオール 📮 郵便番号住所検索・住所逆引き・法人情報API
ソフトウェアを常に最新に私たちはソフトウェアを最新に保つことがいかに難しいかを知っています。 ケンオールはデータを最新に保ち整理するプロセスを自動化し、変更を自動的に取り込むことができます。 さまざまなデータに対するAPIを使用して、既存のシステムを当社のシステムにリンクします。
APIデザインにおける七つの大厄介 | POSTD
(編注：2016/7/29、頂いたフィードバックを元に記事を修正いたしました。) APIをデザインするということは、科学であり技術でもあります。多くの頭の良い人たちが失敗を重ねてきました。成功している人たちは、APIの主な目的を念頭においてデザインしているのです。その目的とは、「開発者たちをウンザリさせる」ということです。 親愛なる仲間たち、その崇高っぽい追求を称えるべく、「APIデザインにおける七つの大厄介」を共に数え上げようではありませんか（私がしたことを見てください）。 リスティクル（箇条書き形式の記事） を書くつもりはないのですが、少なくともタイトルは 教養ある宗教的文献が参照元 です。 まず、ルールを決めましょう。ここでは、成功し、きちんと機能しているAPIを取り上げます。ですから、「動かない」とか、「大量のセキュリティホールがある」といったことは厄介ごとに数えません。「致命的」
Markdownドキュメントをgithubで管理して、はてなブログでホストする ~ Mackerelの場合 - Hatena Developer Blog
はてなチーフエンジニアの Songmu です。この記事ははてなデベロッパーアドベントカレンダー2015の7日目の記事です。昨日は id:mazco による デザインにおける個性のつけ方 でした。 今日は Mackerel の公開ドキュメントについてのお話です。 Mackerelは以下で公式ドキュメントを英語と日本語で提供しています。 help.mackerel.io help-ja.mackerel.io これらは実ははてなブログでホストしています。 翻訳は日本語を先に書いて、それをチームのネイティブ翻訳者が翻訳するフローになっています。 ドキュメントの運営 告知ブログのようなものなら良いのですが、ドキュメントはその性質上定期的なメンテナンスが必要になります。特に以下の様な点がドキュメントを運営する際に難しいところです。 なんらかの一括修正が必要になった場合に修正点を洗い出して一括で反映す
AndroidQueryをやめてRetrofitを使ったら捗った話 | KonifarPod
AndroidでAPIとやり取りする場合、HttpURLConnectionとか使ってスクラッチで書いてもいいんですが、ライブラリを使ったほうが簡単に書けます。 そのような便利ライブラリの１つにAndroidQueryというのがあります。名前からわかるとおりjQueryに影響を受けており、メソッドチェーンを使って簡単にGET・POSTを実装できます。 僕ももともとAndroidQueryを使っていたんですが、今回Retforitというライブラリに置き換えたところコード量も減りとてもいい感じだったのでメモしておきます。 （１）Before After まずはBefore Afterから。 [Before: AndroidQuery] private void loadUsers() { final AjaxCallback cb = new AjaxCallback() { @Overrid
API Documentation & Design Tools for Teams | Swagger
API Development forEveryone Simplify your API development with our open-source and professional tools, built to help you and your team efficiently design and document APIs at scale. Find your toolRead the docs Trusted by Empowering API Development Streamline your workflow with unparalleled API specification support Swagger places API specifications such as OpenAPI, AsyncAPI, and JSON Schema at the
REST APIドキュメント生成パターン - ✘╹◡╹✘
REST API用のドキュメントを生成するときにどうやってるかについて雑記を残しとく。 概要 実装とドキュメントの乖離を避けるためには、同じ意味情報を二箇所以上に定義することを避ける必要がある。そのための方法として、実装それ自身か、もしくは実装が参照している何らかのメタデータを元にしてドキュメントを生成したり、テストの実行結果からドキュメントを生成するというパターンがある。 テストから Cookpadでは、autodocというライブラリを利用して、RSpecでテストを実行している途中で得られたメタデータからドキュメントを生成している。これはテストの実行結果からドキュメントを生成するパターン。 これは実現方法としてはかなり特殊な部類。このパターンが最も効果的に働くのは、ドキュメント生成のために余分な開発コストはあまり掛けたくないが、テストは真面目に書いている OR 真面目に書いてほしい、とい
モバイルアプリのログ収集ライブラリ「Puree」をリリースしました - クックパッド開発者ブログ
モバイルファースト室の @rejasupotaro です。 クックパッドでは、サービスをリリースしてログを収集して分析して改善してまたリリースして、というサイクルを素早く回すことでより良いものを作るということをウェブではやってきました。 クックパッドのサービス開発のフレームワークをモバイルアプリでも適用したいのですが、モバイルアプリにはウェブアプリと違ったロギングの難しさがあります。 今回はモバイルアプリのロギングの問題点とPureeというログ収集ライブラリについて話します。 モバイルアプリのロギングの難しさ ウェブアプリでは、基本的にはサーバー側でログを収集することができますが、モバイルアプリの場合は画面の制御はアプリ側で行われ、APIを介してデータを受け取るため、クライアント側でログを収集して送信する必要があります。 アプリのログを収集するのに、画面遷移をしたりタップするたびにサーバー
Chatwork APIへようこそ！
Chatwork APIは、外部のプログラムから簡単に使用できたり、Chatworkで発生したイベントを外部のプログラムに提供することができます。Chatwork APIを活用したプログラムの開発、または IFTTT や Zapier といったiPaaSをお使いいただくことにより、以下のような連携が可能になります。 自分宛てにメールがきたらChatworkにメッセージとして流す サーバーエラーを検知し関係者にタスクを振る カレンダーに予定が追加されたら、Chatworkでタスクを振る ぜひ、お試しください！ Chatwork画面右上の「利用者名」をクリックして表示されるメニューの「サービス連携」を選択してください。サービス連携画面が開きますので、左側のメニューから「APIトークン」を選択してください。 またChatwork APIのご利用には組織管理者への申請が必要です※。 下記ページから
YappoLogs: 2014年に向けた JSON API の実装の方向性と X-JSON-Status 改め X-API-Status header のご提案
2014年に向けた JSON API の実装の方向性と X-JSON-Status 改め X-API-Status header のご提案 追記 2014/11/20 14:00:00 わりと JSON やら XML やら各種フォーマットで API を運用している環境がある場合に JSON API の時だけ X-JSON-Status にすると XML とかの時と整合性取れないし、 X-XML-Status みたいのを量産するのは困る的なレビューを頂いたので X-JSON-Status をやめて X-API-Status にしました。 へたに JSON に限定するから REST とか JSON-RPC とかいわれるんや！ X-API-Status にしたら全部解決したし MessagePack な API でも使い回せるって songmu さん言ってた！ XML とかからどうやって引っこ抜
Python REST API Framework — Eve 0.4-dev documentation
Eve. The Simple Way to REST¶ Version 2.1.0. Eve is an open source Python REST API framework designed for human beings. It allows to effortlessly build and deploy highly customizable, fully featured RESTful Web Services. Eve is powered by Flask and Cerberus and it offers native support for MongoDB data stores. Support for SQL, Elasticsearch and Neo4js backends is provided by community extensions. T
Dropboxのアプリ向け同期機能「Datastore API」と「Synclogue」の違いとは？ | Synclogue Navi
現地時間の7月9日、米Dropboxが、デベロッパー向けカンファレンス「DBX」において、同社が提供する「Dropbox Platform」に新APIである「Datastore API」の追加と「Drop-ins」の改良が発表され話題になりました。なかでも「Datastore API」はモバイルアプリ向けの同期機能を実現する画期的なもの。今回は「Synclogue」（シンクローグ）と比較しながら、その機能について解説しています。2013/07/22 Dropboxのアプリ向け同期機能「Datastore API」と「Synclogue」の違いとは？ 現地時間の7月9日、米Dropboxが、デベロッパー向けカンファレンス「DBX」において、同社が提供する「Dropbox Platform」に新APIである「Datastore API」の追加と「Drop-ins」の改良が発表され話題になりまし
Dropbox、「Dropbox Platform」を発表--ハードドライブそのものの置き換えを目指す
クラウドストレージプロバイダーであるDropboxは米国時間7月9日午前、「Dropbox Platform」を同社初の開発者会議で発表した。Dropboxの最高経営責任者（CEO）で創設者のDrew Houston氏は、Dropbox Platformが「ユーザーに代わって同期の問題を解決する新しい基盤」であることをアピールした。 Houston氏によると、Dropbox Platformには構造化データの同期の維持、オフラインでの作業、コンフリクト（競合）への対処、複数OSにわたる作業などが含まれるという。 「同期とは新しい保存のことである。われわれは決して過去を振り返らない」とHouston氏は述べ、この特定の機能がすべてのユーザーに影響を与える問題であることを付け加えた。 Dropboxは2012年11月、ユーザー数がおよそ1億人に達していた。9日の時点で、同サービスのユーザー数は
Location changed to developer.github.com
Location changed to https://developer.github.com/v3/libraries/.
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Welcome
http://www.pythonapi.com/