何？Swaggerって？ - ponsuke_tarou’s blog
お仕事で「APIの仕様書をすわっがーで作ってね」って言われました、既存の仕様書はYAMLファイルになっているのですが・・・何？Swaggerって？ Swaggerは、OpenAPI仕様に基づいてREST APIの仕様書作成から構築を助けてくれるツールです。 OpenAPIは、REST APIの記述フォーマットです。 Swagger3.0は、OpenAPI？ ブラウザで仕様書を見て書けます。 実行もできます。 GitにあるSwaggerのファイルをプレビューできるChrome拡張機能があるらしいです。 Serversを書く 認証を書く Bearer スキームを書く 共通で使うオブジェクトや構造の定義を書く リクエストを書く パラメータを定義する レスポンスを書く レスポンスのexampleを複数定義する YAMLファイルに保存する Swaggerは、OpenAPI仕様に基づいてREST AP
REST WebAPIのプラクティス｜yamarkz - Kazuki Yamaguchi
雑なメモ書きの様な内容です。 自分の知識、知恵の引き出しの整理も兼ねてます。 実践的で有用な対応パターンをまとめました。 HTTP Method with URI| http method | explain | URI | |GET| ドキュメントリソースの取得| https://api.example.com/v1/items/1 | |GET| コレクションリソースの取得| https://api.example.com/v1/items | |POST| リソースの作成 | https://api.example.com/v1/items | |PUT| リソースの更新 | https://api.example.com/v1/items/1 | |PATCH| リソースの部分更新 | https://api.example.com/v1/items/1 | |DELETE| リソ
翻訳: WebAPI 設計のベストプラクティス - Qiita
これは Enchant の開発者である Vinay Sahni さんが書いた記事「Best Practices for Designing a Pragmatic RESTful API」1を、ご本人の許可を得て翻訳したものです。 RESTful な WebAPI を設計しようとすると、細かなところで長考したり議論したりすると思います。また、他の API に倣ってやってはみたものの、本当にそれでいいのか、どうしてそうしているのか分からない、何てことも少なくはないと思います。 この記事では、そのようなハマリどころについて Vinay さんなりの答えを提示し、簡潔かつ明快に解説してくれています。 今後 WebAPI を設計される方は、是非参考にしてみてください。 なお、誤訳がありましたら編集リクエストを頂けると幸いです。 まえがき アプリケーションの開発が進むにつれて、その WebAPI を公
Swaggerで始めるモデルファーストなAPI開発
This document summarizes a microservices meetup hosted by @mosa_siru. Key points include: 1. @mosa_siru is an engineer at DeNA and CTO of Gunosy. 2. The meetup covered Gunosy's architecture with over 45 GitHub repositories, 30 stacks, 10 Go APIs, and 10 Python batch processes using AWS services like Kinesis, Lambda, SQS and API Gateway. 3. Challenges discussed were managing 30 microservices, ensur
WebAPIについての説明 - Qiita
はじめに 新人への説明の為に書きました。 元々は社内勉強会用のスライドのメモだったものを、いい感じに直して公開する事にしました。 「勉強は真面目にするものだ」と考えている人には向きません。 「技術的な事は正確でなければいけない」と考えている人には向きません。 基本的な事から馬鹿丁寧に書いてあるので長いです。時間ある時用の記事です。 誤解を生じるぐらい噛み砕いて簡単に説明してあります。 教科書的に通して読むことでWebAPIが理解出来るように書いてあります。 対象者 htmlとcssは書ける phpとjsを主にコピペでしか書けない IT関連の基本的な用語も知らない、理解してない WebAPI？何それおいしいの？っていう人 どちらかと言うと営業寄りの部署に所属 アジェンダ 第1部 知識編 WebAPIの 仕組みを理解する 用語を理解する 第2部 実践編 WebAPIを作る WebAPIを利用す
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
