こんにちは、タイミーデリバリー開発チームの宮城です。 今回は弊社のOpenAPI3ベースのスキーマ駆動開発の運用方法を紹介します。 TL;DR 技術スタックは OpenAPI3, Swagger UI, Committee, ActiveModelSerializers Committeeを利用してOpenAPI準拠のRequest Specを行う OpenAPI3のrequiredキーワードに注意する 背景 タイミーデリバリーでは、RailsによるAPIサーバーと、Web管理画面としてVue.jsによるSPA、ユーザー向けiOSアプリとしてSwiftを採用しています。 1つのモノリスなRailsで利用者別にネームスペースを区切り、それぞれエンドポイントを提供しています。 サーバーサイドとクライアントサイドを分離し並行して開発を進めるためにスキーマ駆動開発を導入しました。スキーマ駆動開発の
はじめに RailsでAPIを作るぞ!ってなった時にいつも行っているテストやリンターなどの導入手順を備忘録がてら記事にしました。 また、本記事ではRailsアプリケーション自体は最小限の構成で作成し、 なるべく小規模かつ開発に必要なツールは最低限導入しておくことを念頭においています。 完成系 最初に完成系のrepositoryを上げておきます。 実際の実装が見たい場合は下記repositoryをご参照ください。 本記事で扱うこと dockerでmysqlをdbとする最小限のrailsアプリケーションを作成 ヘルスチェック用endpointの実装 テストツール(rspec)の導入 リンターツール(rubocop)の導入 API定義書、並びに関連ツール(OpenAPI, Swagger Editor, Swagger UI, committee)の導入 CI(CircleCI)の導入 CORS
ドキュメントちゃんと保守できてますか？ API開発とドキュメントの保守は切っても切れない問題です。 仕様の記述はもちろんのこと、サンプルを試せるAPIクライアントや、仕様に則った実装になっているかテストも自動化したいですよね。 本記事では、現在開発中のAPIアプリケーションで、実際に僕が試行錯誤していく中でたどり着いたベストプラクティスを紹介しようと思います。 アーキテクチャ iOSアプリのバックエンドとしてJSONを返すAPIサーバー Rails6 × MySQL5.7 on Docker いつもの というお買い物アプリです。 ドキュメント何で書いてますか？ Excel => つらい Markdown => つらい 何らかのDSLを用いて生成するツール => 素でマークダウンを書くのはつらみが深いので何かしらツールを使いましょう。 apiary, api blueprint, APIDO
Rails + React + OpenAPI な環境で、クエリパラメータに配列を指定することがありました。 ただ、実装するまでにいろいろ調べたことがあったため、メモを残します。 目次 環境 わかったこと Railsでは ids[]=1&ids[]=2 な書式のクエリパラメータを受け取れる OpenAPIスキーマでは Parameter Object の style を使って表現する ストロングパラメータでは id: [] のように指定する 現時点では、Committee が Query parameter の explode に対応していない OpenAPI generator typescript-axios は operationId を定義した上で使う OpenAPI generator の Ruby クライアントでは、希望する形での配列ができない 素の faraday を使う場合
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
