はじめまして。TIG DXユニット 1の亀井です。 はじめに みなさん、Swagger使ってますか？ Swaggerや周辺ツールについては 某先輩の記事 にて丁寧に解説されていますので、 本記事では実際にSwaggerのスキーマ定義を設計していく上で取り決めた規約について書いてみたいと思います。 前提私が在籍しているプロジェクトでは、REST APIは golang でフロントエンドを Vue.js + TypeScript で構築しています。 短期間・高品質での構築を実現するためにSwaggerを設計ドキュメントとしてだけではなく、コード自動生成やモックサーバーに活用させることで徹底したスキーマファーストな開発を行ってきました。 というわけで、今回は下記のツールを利用することを前提として規約を作成しています。 go-swagger: Goアプリケーションのハンドラ、リクエスト/レスポンス

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

OpenAPI関連のサイト・ツールまとめ2020.10.29 OpenAPI関連のサイトやツールなどの情報が種々雑多にあるので、自分の中での整理と忘備録として残すためにまとめました。（2020年10月時点） 概要OpenAPIとはOpenAPIという表現が使われた場合、恐らくそれらの多くはOpenAPI Specification（以下OAS）に基づいてJSONやYAMLで記述されたREST APIの仕様書（スキーマ）を指しているように思います。 OASはREST APIの仕様を記述するための規格であり、それ自体がなにかのツールやサービスを提供するものではありません。 とはいえ関連するツールやサービスも普及してきているので、あまり言葉の意味を気にしすぎる必要もないかもしれませんが。 OpenAPI Specification (v3.0.3)Implementer’s Draft (OAS

2022/1/31 追記 いまだにこの記事のPVがあるので Rails アプリケーション作るときに参考になりそうなリンクを追記しておきます。 【Rails】もっと早く知りたかったデバッグ用gem 'better_errors','binding_of_caller' | Qiita https://qiita.com/terufumi1122/items/a6f9a939dce25b2d9a3e 【Rails】better_errorsとbinding_of_callerで自分でエラーを解決できるようになろう【初心者向け】 | Qiita - https://qiita.com/ryokky59/items/284892be879996e4f77c Railsにおけるドメイン駆動設計の実践 | linyclar - https://linyclar.github.io/software_d

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

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

<?php /** * @SWG\Swagger( * host="xxxxx.xxx.net:9000", * basePath="/api", * schemes={"http"}, * @SWG\Info( * version="1.0", * title="血圧管理手帳のAPIドキュメント", * ), * @SWG\SecurityScheme( * securityDefinition="MyHeaderAuthentication", * type="basic", * ) * ) * @SWG\Definition( * definition="Blood", * @SWG\Property(property="date",type="string",format="yyyy-MM-dd",description="日付"), * @SWG\Property(propert

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”として初回リリースすることを予定しています 。 私

APIの定義を書く：Excel仕様書はもういやだ RESTful APIを提供するサーバと、そのAPIを利用するクライアント（たとえばSPA）とを並行で開発しようとするとき、まずAPIを定義して、それに基づいてサーバ／クライアント双方の実装を進めようと考えるのは自然だと思う。 そうと決まれば、「API仕様書_20190110.xlsx」と題するファイルを新規作成し、シート別にリソース毎の定義を書き始め・・・てはいけない。せっかくAPIを定義したドキュメントを作成するなら、するのなら、ソースコードの自動生成などの恩恵も受けたい。受けられるはずだ。 少しググってみる。どうやらSwaggerというものを使えばいいらしい。Swaggerに興味を持ったタイミングで、ちょうど書店に平積みになっていた『WEB+DB PRESS Vol.108』の表紙が目に入った。そこには、「スキーマ駆動Web API開

Swagger UI × Amazon EC2 × Dockerで開発初期からAPIの繋ぎ込みを意識できる環境を構築してみた こんにちは！ PHP × Unityを使った新規開発プロジェクトでサーバサイドエンジニアをしている仙道です。 今回の記事ではSwagger UIとAmazon EC2、Dockerを使って開発初期から繋ぎこみを意識した開発を行うための取り組みを紹介したいと思います。 今回の記事ではAmazon EC2やDockerの基本的な使い方については触れないため、もしこれらについて分からないという場合は、下記のドキュメント等を参照いただければと思います。 Amazon EC2 : http://docs.aws.amazon.com/ja_jp/AWSEC2/latest/UserGuide/concepts.htmlDocker : https://docs.docker.

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? みなさんは、開発初期の段階でWeb API(以下API)の実装が追いつかずクライアント側が開発できないという経験をしたことはありますか？ クライアント側はAPIがないと開発が滞ってしまうことがありますが、かといってAPIの開発も始まったばかりではすぐに必要なAPIを提供することができません。その問題を解決し、両者でスムーズに開発をすすめるために有効な方法の1つに、APIモックの作成があります。 弊社では、開発初期の段階でSwaggerとその周辺ツールを使ってWeb APIのモックを作成し、スムーズに開発できるようにしています。 Swag

Swaggerとは Swaggerは言語に依存しないREST APIのインターフェース仕様とそのツール群を指す。 Swaggerの仕様に沿ってAPIを定義することで、人間が理解可能で、コンピューターにも解析可能なAPI仕様書となる。 引用：http://d.hatena.ne.jp/takeR/20151207/1449469957 らしいです。 ともあれ導入 環境 CentOS 6.5 x86_64 PHP環境（PHP5.5、Nginx1.8） CodeIgniter3.0.6 composerインストール $ curl -sS https://getcomposer.org/installer | php All settings correct for using Composer Downloading 1.0.0... Composer successfully installe