CTO兼福岡オフィス立ち上げ担当として新アプリを作っている@edvakfです。 JSON APIを開発しているとこういう問題がありがちですよね。 仕様どおりにAPIの形式を作ったはずだけどなんか自信が持てない テストでいくつかのキーが存在するかの簡単なチェックはしてるつもりだけど、全部チェックするのは大変すぎる APIのControllerやViewをリファクタリングしたらレスポンスの形が変わってアプリがめっちゃクラッシュし始めた というのが怖くて誰もリファクタリングできなくなった APIドキュメントがメンテされない 知らない間にレスポンスのフィールドが増えてたけどドキュメントに書いてない これらを解決したい！と思って試行錯誤したら、スマートに解決することができました。この記事ではRailsのことについて書きますが、考え方は他の言語・フレームワークでも同じです。 なお、今回使ったgemのバ

目次 [[toc]] 概要 OpenAPIとは OpenAPIという表現が使われた場合、恐らくそれらの多くはOpenAPI Specification（以下OAS）に基づいてJSONやYAMLで記述されたREST APIの仕様書（スキーマ）を指しているように思います。 OASはREST APIの仕様を記述するための規格であり、それ自体がなにかのツールやサービスを提供するものではありません。 とはいえ関連するツールやサービスも普及してきているので、あまり言葉の意味を気にしすぎる必要もないかもしれませんが。 OpenAPI Specification (v3.0.3) Implementer’s Draft (OAS 3.1 RC1) Available for Feedback – Please Respond by Nov 8! 現在の最新バージョンは 3.0.3 、次のバージョンとなる

OpenAPI OpenAPI、正確にはOpenAPI SpecificationはREST APIの定義を記述するための規格です。 つまり、APIサーバがどのような挙動をするのかを記した設計書のようなものです。 2015年末まではSwagger Specificationと呼ばれていたので、こちらの方を知っている方もいるかもしれません。 さて、これがあると何が嬉しいかというといろいろ嬉しいことがあるのですが、主なメリットは次の3点です。 APIを決まったフォーマットで規定できる そのままAPIドキュメントになる API定義からサーバやクライアントのコード生成ができる Swagger時代からSwagger Specificationに関連したツールが出回っており、ツールを利用することで手軽に上記のメリットを享受できるようになっています。 メリット 代表的なツール

APIエコノミー・マイクロサービス時代が到来し、APIやサービスの組み合わせによるシステム構築が当たり前になってきています。 そんな中、API仕様記述フレームワークであるSwaggerの勢いはとどまることを知らず、非常に多くの方が使われていると感じます。 2017年7月26日にSwagger 3.0(OAS:Open API Specification 3.0)が公開されました。Swagger Specと呼ばれるAPI仕様をよりシンプルに記述できるようになり、再利用性(componentsによる再利用部分の集約)が向上しています。

はじめに 新しくAPIサーバーを建てるまでの話 新サービスを建てるにあたり考えなければいけないこと 開発を進めるにあたり 言語・フレームワーク・ミドルウェア選定 フレームワークどうするか GraphQLを採用するか、JSONのREST APIにするか サーバー構成をどうするか 構成管理（Infrastructure as a Code） ローカル開発環境はどうするのか CI環境を用意しておくことは重要 コーディング規約や各種規約はどうするのか API仕様作成時の方針について 各環境へのデプロイはどうするのか DDoSやSQLインジェクション対策はどうするのか DDoS対策 CORS, CSRF ミドルウェアの脆弱性 フェイルオーバーの仕組みをどうするか APIサーバーが1台落ちたときに利用者に影響が出ないか 接続先のDBが落ちた時に影響が出ないか サーバー（サービス）監視 ドキュメントをS

今回、サーバ・フロントの完全分業実現のため Swaggerを導入し、APIの仕様を管理、かつモックサーバとして機能させることに。 仕様を決める→モックサーバとして動作させるまでの流れメモ。 動作確認環境 流れ 前準備(brew/npmは入ってる前提) swagger形式のAPI仕様書作成 動作確認環境 Mac OS X以上 Swagger2.0 (Open APIは3.0が最新ですがswagger-codegen使用のため2.0を使用) はやく3.0対応してほしみ。。。 流れ ※色々インストールなどの前準備※ ①API仕様をSwagger形式(yaml)で記載、 ②Swagger-Codegenを使用してnode.jsのプロジェクトへ変換 ③サーバ起動 →モックサーバとしてブラウザ上での確認、 自分のプロジェクトからもレスポンス確認ができる 良いこと： * Githubでyamlファイルの

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

2018-05-12、OpenAPI Generator が公開されました。 https://github.com/OpenAPITools/openapi-generator OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec これは Swagger Codegen v2.4をフォークしたプロジェクトで、OpenAPIドキュメントから様々なプログラミング言語のAPIクライアントやスタブサーバーなどのソースコードを生成するツールです。まだベータ版のような状態で、“v3.0.0”として初回リリースすることを予定しています 。 私

SwaggerのPHP実装であるSwagger-PHPの使い方についてLaravelプロジェクトで確認し、Swaggerとはどんなものか調査したメモになります。 Swaggerの全体像については、「RESTful APIの記述標準化を担うSwaggerとは？ | NTT Communications Developer Portal」が参考になりました。 Swaggerを利用したアプリケーション開発は、まずSwaggerドキュメントを作成して、サーバーのスタブとクライアントライブラリを生成し、APIロジックとクライアントUIなどを実装していくような流れになるといったところのようです。 Laravelはありませんが、コード生成ツール swagger-codegen には、Laravelの軽量版であるLumen用のサーバースタブは生成可能です。 この記事では、Laravel 5.2プロジェクト

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article?

背景 初投稿です。イレブンナインの松田です。@matsudachikara2 最近、社内でAPIの仕様をどうやって管理、共有していくかを検討してました。そこで、Swaggerを使うのがいい感じらしい！ということを聞き、調査を始めましたが、個々のツールの使い方や導入は出てくるものの、具体的にチームで共有、管理まではどうやってするのかいまいち分かりませんでした。 調べていくとSwaggerHubなどのプラットフォームを使うのが一般的みたいでしたが、もっと簡単にSwagger EditorとSwagger UIとSwaggerのモックAPIサーバーを使えたらなということで作ってみました。 Swaggerとは？ こちらはとても良い記事がすでにありますので、そちらを見ると良いと思います！ Swaggerの概要をまとめてみた。 開発効率を上げる！Swaggerで作るWEB APIモック Swagger

要約 swaggerの説明 使い方 背景 クライアントとサーバーの実装者が分かれていて情報共有に時間がかかる状況です。 事前にAPIの仕様だけは固めて共有しておきたいです。 ただ、手書きのドキュメントの場合は曖昧な表現が残り、誤解が生じる可能性があります。 ドキュメントのバリデーションができると嬉しいです。 欲を言えば、仕様の動作を確認するためのスタブサーバが作れると嬉しいです1。 そこでswaggerを使います。 swaggerとは？ SwaggerはWeb APIのドキュメンテーション仕様と、それを作る・使うツール群です。 ドキュメンテーション仕様 最新のドキュメンテーション仕様はOpenAPI 3.0です。 ツール群の対応が終わっていません。 現時点では、前身のSwagger 2.0を使います。 Swagger Editor Swagger Editor はSwagger 2.0を編

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article?

概要 API通信処理、どんな方法で実装していますか？ クライアントアプリを開発してると何かと書く機会が多い部分ですが、アプリごとに頑張って書いていくの面倒ですよね。 同じ言語ならライブラリとして切り出せば良いですが、プラットフォームが違う場合は大抵言語も違うので、その場合は再開発する必要が出てきて辛いですよね。 そういう時はSwaggerを使うとその問題解決、あるいは軽減できるかもしれません。 今回はSwaggerを使った通信処理を自動生成する方法を紹介したいと思います。 こんな人にオススメ APIドキュメントの追従や管理がつらい プラットフォームごとに実装書くのつらい JSONをいい感じにパースするライブラリがない （もしくはあるけど実装がめんどい） APIガッツリ使うプロダクトなのに、開発開始直後でサーバー側にAPIが用意されてない 結合まで待ってたら作業進まない javaはGsonと

はじめに こんにちは。しがないOLくにきちです。 ブログ書くのが少し空いてしまっていたら、いつの間にか Springfox のバージョンが上がって 2.7.0 -> 2.8.0 になっておりました！ヽ(▽｀)ノﾜｰｲ♪ 前回のブログで設定した内容に追加をしたいと思いますので、後述します。 本ブログの構成 バージョンアップに伴う設定の追加 Swagger ドキュメントのカスタマイズ API定義（@Api） API操作定義（@ApiOperation） レスポンス定義（@ApiResponses、@ApiResponse） パラメータ定義（@ApiParam） バージョンアップに伴う設定の追加 冒頭で書きましたが、Springfox のバージョンが 2.7.0 -> 2.8.0 になりました。 このアップデートで Swagger-ui が 3系 になっているので、見た目がガラリと変わります。

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article?

これらを基本的にAnsibleで実装・管理していきます。 取り扱わないこと Lambdaの管理、デプロイについては長くなりすぎるので対象外とします。 色々素晴らしい記事があるのでそちらをご覧ください。 https://qiita.com/marcy-terui/items/db8dae512af3c553fe72 https://qiita.com/kikusumk3/items/119bfb2da854c2b83791 まぁLambdaに関しては実装の意味合いが強いので 最初はAnsibleじゃなくていいなーと思ってました。 が、ほかが案外すんなりAnsibleに落としこんでくれたので ちょっとLambdaのデプロイだけ浮いちゃってるかもしれないですね。 各サービスでの設定 API Gateway API定義を考える どのようなAPIにするか考えておきます。 ここでは説明の為に 仮決めと

概要 最近は API Blueprint で仕様書を書くことが多かったのですが、Swagger が世界標準になるかもしれない、ということもあり、開発の効率化を進めるためにも概要をまとめてみようと思った次第です。 Swaggerとは Swagger は RESTful APIを構築するためのオープンソースのフレームワークのことです。「Open API Initiative」という団体がRESTful APIのインターフェイスの記述をするための標準フォーマットを推進していて、その標準フォーマットがSwaggerです。Swaggerには多くの便利なツールが提供されていることもあり、多くのメリットを享受できそうです。 Swagger Spec を書いておけば自動的にドキュメント生成までしてくれ、それだけではなく、ドキュメントから実際のリクエストを投げられる優れものです。 Swaggerのツール群