SwaggerでWeb APIを作る - APIを実装する - GIG
この記事はFujitsu Advent Calendarの20日目です。 Swaggerとは? 前のポストではSwaggerでWeb APIを設計し、ドキュメント化、モックサーバの起動について書いた。 改めてSwaggerについて。 REST API設計とそのツール群 仕様書(YAML形式)を書くことでそれから機能を作れたり、ドキュメント化して公開するなど仕様の齟齬をなくす メンテされなくなったExcelで書いた仕様書といったものを防げそう REST APIの標準化団体Open API Initiativeが仕様として採用した Flaskサーバを実装 使うAPI仕様書は、出来合いのPetstore(Simple)のものを使う(Swagger Editorで[File] > [Open Example...]でpetstore_simple.yamlを選択)。その仕様に沿ったサーバ機能の雛形
RESTful APIのURI設計(エンドポイント設計) - Qiita
RESTful APIのリソース設計で述べた通り、何をリソースとするかを決めたらそのリソースを識別するURIを検討する必要がある。 エンドポイントとは何か エンドポイントとはAPIにアクセスするためのURIのこと。例えば、QiitaのAPIで自分の情報を取得する時のエンドポイントは以下となる。 http://qiita.com/api/v2/users/nagaokakenichi 似たような言葉に「エントリポイント」というものがある。エントリポイントとはプログラムやサブルーチンの実行を開始する場所のこと。 Qiita視点で考えると、 http://qiita.com/api/v2/users/nagaokakenichi を参照されることでプログラムが開始されるので、Qiitaからすると上記URIはエントリポイントとなる。 つまり、エンドポイントはAPIにアクセスする側からの、エントリポ
REST APIとは？ - API設計のポイント
最近は様々なサービスでWebAPIが提供されています。普段の開発をする中でもシステム連携などでAPIを作る機会が出てくるのではないでしょうか。 WebAPIの中でもREST APIなんてものもよく聞くのかなぁと思います。REST APIの設計は色々と奥が深く、なかなかおもしろい技術です。 今回はそんなREST APIを設計する上でのポイントをご紹介していきます。この記事では実装よりも設計思想的な部分を書いています。次回以降にもう少し実装に近いレベル記事を書いきます！ REST APIとはRESTの原則に沿った形で設計されたAPIを指します。 じゃあ、RESTってなんぞや？となると思いますが、参考サイトにはこんなことが書かれています。 「セッションなどの状態管理を行わない（やり取りされる情報はそれ自体で完結して解釈することができる）」（Webシステムでは、HTTP自体にはセッション管理の機構
railsでGrapeを使ってAPI作成、プラス例外処理 - Qiita
module GrapeSampleApi class Application < Rails::Application config.active_record.raise_in_transactional_callbacks = true config.autoload_paths += %W(#{config.root}/lib/api)#←追記 end end # lib/api/api.rb # coding: utf-8 class API < Grape::API # APIアクセスに接頭語を不可 # ex) http://localhost:3000/api prefix "api" # APIアクセスにバージョン情報を付加 # ex) http://localhost:3000/api/vl/ version 'v1', :using => :path # 未指定の場合に
RailsでAPI開発する前に知っておくべき４つのこと - Qiita
$ bin/rails g scaffold user name:string mail:string password:string invoke active_record create db/migrate/20151214145437_create_users.rb create app/models/user.rb invoke test_unit create test/models/user_test.rb create test/fixtures/users.yml invoke api_resource_route route resources :users, except: [:new, :edit] invoke scaffold_controller create app/controllers/users_controller.rb invoke test_un
RedmineのAPIでチケットを操作してみた。 – けんさんのIT知識
RedmineのREST APIをつかってRedmineに対してチケットを登録してみました。 RESTClientとしては、お手軽に使える rest-client のUI版（ http://code.google.com/p/rest-client/ ） を使用します。 あらかじめ、認証に必要なAPIキー(apikey)を個人設定画面から取得しておきます。 チケットの登録 通常のチケット登録は以下のような感じです。 RequestURI POST /issues?key=apikey Header Content-type: text/xml Body <issue> <project_id>1</project_id> <subject>TEST</subject> </issue> 成功するとステータスコードとして201が返り、 ResponseBodyに登録された内容が入ります。 i
Rest api - Redmine
Status legend: Stable - feature complete, no major changes planned Beta - usable for integrations with some bugs or missing minor functionality Alpha - major functionality in place, needs feedback from API users and integrators Prototype - very rough implementation, possible major breaking changes mid-version. Not recommended for integration Planned - planned in a future version, depending on deve
Redmine REST API - r-labs - Redmine
ステータスの凡例 : Stable - 仕様機能は完成されていて、今後の大きな変更は予定されていません。 Beta - まだバグが残っているか、いくつかの細かな機能が実装されていません。 Alpha - 主要な機能は出来てますが、まだ API 使用者からのフィードバッグを必要としています。 Prototype - 試験的な運用のためにざっと実装されただけで、今後大きな変更が加わる可能性があります。 本格的に使用するのはお勧めできません Planned - 将来のバージョンで予定されているもので、いつになるかは開発参加者しだいです。 各データ共通¶ ユーザー認証¶ ほとんどの場合、 API では認証を必要とします。 API 型式での認証を可能にするためには 管理 → 設定 → 認証 の順で設定ページを表示した後、 [REST による Web サービスを有効にする] にチェックを入れます。 そ
Rest api with curl - Redmine
Using the REST API with cURL¶ curl is a command-line tool for transferring data using various protocols. It can be used to interact with the Redmine REST API. Using JSON¶ Here is a simple example of a command that can be used to update an issue: curl -v -H "Content-Type: application/json" -X PUT --data-binary "@388.json" -u login:password http://redmine/issues/388.json curl -v -H "Content-Type: ap
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
