タグ

関連タグで絞り込む (2)

タグの絞り込みを解除

APIとドキュメントに関するtakaesuのブックマーク (2)

  • WebPay: Ruby開発者向けクレカ決済サービス

    curl APIドキュメント このAPIは、 Rest を基に構成しています。つまりは、開発者にとって予測可能で、リソース指向のURLを用い、HTTPレスポンスコードをAPIエラーの表示に用い、HTTP認証等のHTTPの機能に沿った実装を行っています。つまり、HTTP通信が利用できるあらゆるクライアント・技術で簡単にAPIを利用することが可能です。全てのAPIによるレスポンスはエラーも含めて、 JSON 形式で返します。 このAPIを最大限楽しめるように、番用の番モードのAPIキーだけでなく、全てのユーザーはテストモードのAPIキーを利用することができます。テストモードのAPIキーを用いることで、実際のクレジットカードへの課金や手数料の支払い等を行うことなく、全てのAPIの機能を試すことができます。 Rubyドキュメントはこちら APIエンドポイント https://api.web

  • APIドキュメントを支える技術 - Qiita

    最近のウェブ開発では各機能ごとをAPIでつなぎ込む時代になっています。 そのため、各チームが開発をしていく上で、 他のチームにAPIの仕様を伝える方法をきちんとまとめておく必要が出てきています。 そんな中でAPIドキュメントにどのような役割が求められていて どのような選択肢があるか、一旦自分の把握している知識をまとめています。 (ここで書いているAPIは、httpでアクセスしたら、JSON形式でレスポンスを返すウェブサービスのAPIを指しています) APIドキュメントを用意する上で、すぐにぶつかる壁 APIドキュメントを用意する場合に、何も考えずにExcelやwikiにまとめると、早い段階で メンテナンスのコスト の問題にぶつかります。 『APIドキュメントを書く時間がない』 『当にドキュメント通りの結果が返ってくるか、試してみないとわからない』 『実際に返ってくるAPIとレスポンスが違

    APIドキュメントを支える技術 - Qiita
  • 1