You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
この記事について この記事は、DroidKaigi2018の以下の発表に刺激を受けて書いた記事です。 まだAPI定義管理で消耗してるの?〜Swaggerを用いた大規模アプリ時代のAPI定義管理とコードジェネレート〜 すばらしきGraphQLのSEKAIへようこそ gRPCとProtocol Buffersで一味違うAndroid通信 上記の発表では、Swagger、GraphQL、gRPCとProtocol Buffersという言葉が出てきました。これらはサーバー/クライアント間のAPI通信を実現するために役立つものです。しかし、Swaggerはツール、GraphQLはクエリ言語、gRPCとProtocol Buffersは設計指針(を実装したライブラリ)とデータフォーマットというように同格に扱えるものではないので、ちょっと混乱してしまいます。 そこで、この記事ではサーバー/クライアント間
概要 Web、モバイル問わず、アプリケーション開発する際には、フロントエンドとバックエンド開発が一斉にスタートすることが多く、フロントエンド開発はバックエンド開発待ちになるケースがよくあります。この待ちの時に、フロントエンド側で仮で叩ける環境があると、実装をある程度進めることができ、開発が進みやすくなります。 この記事では Swagger と Heroku を用いて、 API のドキュメントとモック(スタブ)サーバーを手軽に作る方法を紹介します。 Swagger って? Swagger は特定の書式で書くと API ドキュメントとかモックを良い感じで生成してくれるやつです。詳しい説明は公式ページをご参照ください。 手順 Swagger Editor で YAML 整形 モック&ドキュメントのサーバーサイドコードを Generate する Heroku 用の修正をする Heroku にデプロ
背景 2017/7にSwaggerはOpenAPI Specificationとして生まれ変わりました。 正確にはSwaggerの開発元(?)であるSMATRBEAR SoftwareがSwagger2.0をOpen API Initiativeに寄贈し、それを元にOpenAPI Specification(以下OAS) 3.0が作られました。 Swagger2.0と比較してOAS3.0では様々な拡張とリファクタリングが行われましたが、その中でParameter Objectについて記法がかなり拡張されたのでそれについて書きたいと思います。 そもそもSwagger(OAS)って何? こちらの記事でも述べましたが、この時と多少変わっているので、 https://swagger.io/specification/ から引用します。 The OpenAPI Specification (OAS)
概要 Web、モバイル問わず、アプリケーション開発する際には、フロントエンドとバックエンド開発が一斉にスタートすることが多く、フロントエンド開発はバックエンド開発待ちになるケースがよくあります。この待ちの時に、フロントエンド側で仮で叩ける環境があると、実装をある程度進めることができ、開発が進みやすくなります。 この記事では Swagger と Heroku を用いて、 API のドキュメントとモック(スタブ)サーバーを手軽に作る方法を紹介します。 Swagger って? Swagger は特定の書式で書くと API ドキュメントとかモックを良い感じで生成してくれるやつです。詳しい説明は公式ページをご参照ください。 手順 Swagger Editor で YAML 整形 モック&ドキュメントのサーバーサイドコードを Generate する Heroku 用の修正をする Heroku にデプロ
今や RESTful API スキーマ定義のデファクトスタンダードとなった感のある Swagger。ですが、どうにも今いちドキュメントが整備されてないのかわかりづらいのかで、やりたいことがあってもどんなツールがあってどれを選ぶべきか、それらの組み合わせや使い方がわからず困ることが個人的に多いです。 SPA の開発で、swagger.yaml からローカル環境にスタブサーバを立ててフロントエンドのテストに使いたかったのですが、これまたやり方がわからず色々調べてようやくできるようになったので、その備忘録を残しておきます。 なおこの記事は Mac ユーザーの方が対象で、すでに Homebrew と Node.js はインストールされているものとします。 1. スキーマ定義ファイルを用意 まずは Swagger のデモとして超有名な Petstore API の YAML ファイルを落としてきまし
CAMはエンタメコンテンツ、ビジネスバラエティメディア、ライフスタイルメディアを主軸に30以上のサービスを展開しています。エンタメコンテンツの分野では、国内外で圧倒的人気を誇るアーティストやアイドルグループとのパートナーシップを結び、オフィシャルファンサイトや動画関連サービスを運営しています。
管理画面のフロントエンドコードを書く時代は終わりました。 Vironがあれば、OpenApi(Swagger)でAPI定義を行い、実装するだけで管理画面が完成します。 そしてこれはOSSです。誰でも自由にお使いいただけます。 概要 Vironは、複数の管理画面を管理できるよう設計された、管理ツールマネージメントコンソールです。 APIサーバーとOAS2.0 jsonファイルを作成するだけで、管理画面が一つ完成します。 経緯 私の会社では、大小さまざまな自社サービスが開発・運用されています。 管理画面をサービス・サイト毎に作っていましたが、それには限界がありました。 エンジニアからしたら、管理画面用のデザインやAPIを作らなきゃいけない。工数がかかる。 運用・プロデューサーは、UI・UXが管理画面で違うため、操作を覚えるという学習コストが高い。 さらに外から見たいときにスマホから見れないし、
You can tell me by the way I walk - Genesis Swagger::Diff is a utility for comparing two different Open API Initiative (OAI) specifications (fka Swagger specifications). Its intended use is to determine whether a newer API specification is backwards-compatible with an older API specification. It provides both an RSpec matcher and helper functions that can be used directly. Specifications are consi
本記事では、SwaggerのAPI定義を行うSwagger YAMLの記法についてまとめてみました。 使い初めはとっつきにくいSwaggerですが、この記事がSwaggerを使う方の参考になれば幸いです。 Swagger Editorの紹介 Swagger YAMLを書く際には、Swagger Editorがとても便利です。 画面左側がエディター、右側がSwagger UIとなっておりリアルタイムで記法のチェックや定義書を確認できます。 Swaggerを書くエディタはいろいろありますが、気軽に記法を試す際にはSwagger Editorがとても便利です。 ぜひこれから紹介する記法を試す際にも、ぜひ使ってみてください。 初級編 基本の記述 初めにSwagger YAMLを記述するにあたり必須であるswagger, info, pathsについて説明します。 上記の基本的な構成で記述したシンプ
NEWSwagger Inspector is now SwaggerHub Explore See how an API behaves in the real world. Instantly. Quickly validate the functionality of an API to accomplish your goals Start Exploring Design, document, and understand your APIs all in one place Go a step further from documentation to really understand the APIs before implementation. Accelerate your development process by going from documentation
If you're not using the latest master to generate API clients or server stubs, please give it another try by pulling the latest master as the issue may have already been addressed. Ref: Getting Started Search the open issue and closed issue to ensure no one else has reported something similar before. File an issue ticket by providing all the required information. Test with the latest master by bui
Stay up-to-date! We launched the cloudonaut blog in 2015. Since then, we have published 387 articles, 89 podcast episodes, and 97 videos. Our weekly newsletter keeps you up-to-date. Subscribe now!. Subscribe Our weekly newsletter keeps you up-to-date. Subscribe now! It's all free. I want to subscribe to the newsletter with new content as well as announcements regarding products and services. The n
こんにちは、サーバーサイドエンジニアの本間です。 以前弊社のしだより、デジタル連絡帳アプリ るくみーnote のクライアントサイド開発の一部 をご紹介させていただきました。 今回は、このプロダクトのサーバーサイド開発で工夫した点をご紹介したいと思います。 この開発におけるサーバーサイドエンジニアの主なタスクは、デジタル連絡帳のデータを保管するためのAPIサーバーの構築です。 今回、アプリとサーバーは完全分業で並列に開発を進めることから アプリケーション開発者にいかに早くAPIの仕様や動作を理解してもらえるか が開発を円滑に進める上での鍵になりそうだなと考えていました。 この問題に対応するため、以下の2つの対策を可能な限り工数をかけずに実施したいと思い、調査しました。 わかりやすいドキュメンテーションの用意 簡単にAPIを試すことができる環境の整備 Swagger UI 上記の要件を満たすツ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く