FastAPIのスキーマクラスをOpenAPIから生成する方法2022.03.04 PythonでAPIを構築する要件があり、フレームワークに比較的モダンなFastAPIを採用しました。FastAPIはバックエンドの開発を行えば自動でOepnApi定義を生成する機能が備わっていますが、今回はこれを使わず、事前に用意したOepnApi定義からFastAPIで利用するスキーマクラスを生成する方法を紹介します。 OpenAPI定義からFastAPIで利用するスキーマクラスを出力すると何が良いのか？ OpenAPI定義のみで設計の確認が可能FastAPIでクラスを書く必要がなくなるOpenAPIの準備FastAPIのソースコードとOpenAPI定義は以下のような構成で準備します。 ちなみに定義ファイルのパスが generated/openapi.json となっているのは、openapi-gene

Laravelのオブザーバーが便利だった2021.08.30 オブザーバーを使って、モデルのCRUDイベントキャッチしようという試み オブザーバーを使う目的「データに手を加えたユーザーを記録したい」という要望があり、 データの作成者、編集者、削除者をDBに保存することになりました。 やることDBの各テーブルにcreator,editor,deleterカラムを追加マイグレーションファイル作成 (例) php artisan make:migration add_creator_editor_deleter_to_all_table Observer.phpを作成してCRUDイベントをキャッチnamespace App\Observers; use Illuminate\Database\Eloquent\Model; use Illuminate\Support\Facades\DB; c

Shopify の Storefront API を使ってサイトにEC機能を追加する2021.09.02 新規・既存問わず、ウェブサイトに簡単にEC機能を追加できるShopify の Storefront APIを紹介します。 弊社の担当したプロジェクトでサイトにEC機能を追加したいというを話をいただくことが度々あります。 参考事例） ・ 秘密厨房 -Himitsu Kitchen- https://himitsu.kitchen/ ・ Julie - ジュリー｜世界中のワインからあなただけの１本を https://julie.page/ その際に弊社では Shopify の利用をおすすめすることが多いのですが、どれだけ簡単にECのカート機能を追加できるのかというのをご紹介します。 カート機能を追加する際に利用するのは Shopify の Storefront API を利用します。 St

Laravelのログ出力のカスタマイズ2021.09.02 Laravelのアクセスログとクエリログを独自フォーマットで出力する方法をご紹介します。 環境Laravel6Loggingクラスの作成まず、app/Logging/ にActiondログの内容を定義するFormatterクラスを作成します。ActionとQueryは出力内容に関するフォーマット部分が違っています。また、これは環境にもよるのですが Auth::id() によりユーザIDを取得する際にDBへのアクセスが発生することがある為、QueryLogFormatterでは staticの変数 $disableUserId を使ってそれを制御しています。この制御方法はもっと適切な方法がありましたら教えて欲しいです。 // app/Logging/ActionLogFormatter.php <?php namespace App

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

ClickUpの締切を過ぎたタスクを見える化しました2020.08.07 ClickUpで管理しているタスクが締切を過ぎても気づけない状態になっていたので、Slackに通知してわかりやすく目につくようにしました。 ここしばらく弊社ではタスク管理に ClickUp を利用しています。 案件ごとにSpaceを作りタスク管理するのはもちろん、社内の事務作業等細々したものまで管理するようにしています。 ClickUp: What are Spaces?最近Spaceやタスクが増えてきたことで、もともと設定した締切を過ぎてしまうタスクが出てきているのですが、それに気づきにくい状況になっているなと感じていました。 納品やリリースなどの大きな目標や優先度の高いタスクはいいのですが、やろうと決めたものの優先度の低いタスクが残っていたり、単純にタスクのステータスを更新していないケースもあります。 やったこと

GraphQLやめました2020.05.27 当初Golang + GraphQLで作っていたAPIをRails + OpenAPIで作り直しました。なぜGraphQLで始めたのか、どうして作り直すことにしたのかなどを経緯とともにまとめました。 始まり弊社では qrop という農家さん向けのサービスを鋭意開発しています。 私はAPI等のバックエンドの開発を主に担当しており、このサービスの開発を始める段階でAPIは GraphQL にしよう、という話になりました。 GraphQL | A query language for your APIこの時点でGraphQLである必要性はなく、詳しいメンバーがいたわけでもなく、新しい技術に触れておきたいよねという程度の理由でした。 せっかくだしGolangで開発しよう、インフラはGCPにしよう、という具合にその時やりたいことを詰め込んで開発はスタート

テスト管理ツールQaseを使ってみての紹介と感想2020.04.03 少し前にQaseというテスト管理するツールが紹介されていて、使用する機会があったので、機能と感想を紹介します。 今までテストの管理はスプレッドシートやExcelを使っていました。Qaseの他にもテスト管理のソフトウェアはあるようですが、それらのアプリケーションに関しては使用したことがありません。また、今回の内容は無償プランの利用となっています。 Qaseの機能はこの方が詳しくまとめています。 https://qiita.com/henjiganai/items/9fadf6d1099357b49e9c 構造の解説先にQaseの構造を説明しておきます。有料バージョンではもっと機能が増えるようです。 Project - 名前のごとくプロジェクト毎に作成 L Repository - テストケースをここに追加していきます L

OpenAPI Generator + TypeScript で始める自動生成の型に守られた豊かなクライアント生活2020.02.28 OpenAPIをドキュメントだけでなく、Schema firstな開発に利用しようということで、TypeScript + OpenAPI Generatorでフロントエンドの開発をしました。 Vue, Nuxtで使う際の例と共にその内容を紹介します。 目次OpenAPIでドキュメントを書くメリットなどOpenAPI GeneratorでClient情報を吐き出すVue, Nuxtで利用するAPIの変更に追従しやすく、型もあるし幸せOpenAPIでドキュメントを書くメリットなど弊社では以下のブログでも書いているように、API仕様のドキュメント化にOpenAPIを活用しています。 committee×OpenAPI×RailsでスキーマファーストなAPI開発O

GiFTの制作ワークフロー [2020 ver.]2020.02.23 制作する上でのさまざまなコミュニケーションの方法を共有しつつ、どうしていきたいか、どう変えていくか考えていきます。 在宅勤務が推奨されている現在、さまざまな会社での現状が共有されていていますね。 クックパッドの在宅勤務環境 - クックパッド開発者ブログ GMO ペパボのリモートワーク状況 2020 - ペパボテックブログ 1つ1つのノウハウの共有というのはもちろん、社員を多く抱える企業がこのような取り組みを共有してくれるのは業界全体にとっても良いことだなと思います。 業界や社会を構成しているのは1つ1つの会社であり、それを動かしているのは自分だという意識と実践を忘れないようにしたいです。ということでGiFTでのコミュニケーションについてもまとめました。 とはいえ現状は4人の会社ですし、リモートワークに限らずどのように仕

GitHubを少し便利に使えるようなChrome拡張機能を作った2020.02.24 日々使うGitHubで外部リンクをブラウザの別タブで開けたらいいなと日頃から思っていたので、それを解決するChrome拡張機能を作って動かしてみました。 前書き最近は仕事・プライベートに限らず、PCやスマホでWebブラウザを開かない日はないと言っても過言ではないように思います。 その中でも GitHub は個人的に利用する頻度が高いサービスのひとつです。 自分の関わるプロジェクトでPull RequestやIssueを見るだけでなく、OSSのリポジトリでREADMEを読んで使い方を学んだり、ソースコードを直接読むこともあるでしょう。 そんななかでちょっとした不満というか、ここがこうだったらいいのになと思ったのがリンクを開く時の挙動でした。 やりたいことGitHubのWebページで外部リンクを新規タブで開け

Prisma2を使ってREST APIを実装してみる2020.01.23 Modern DB toolkitと謳うPrisma2の使い心地を試すべく、Prisma2のツールを使ってREST APIを実装してみました。 Prisma というデータベースに関する便利な機能を提供するツールをずっと触ってみようと思っていたのですが、次期バージョンが鋭意開発中でプレビュー版として使えるようなので簡単なREST APIを開発しながら使い勝手を見てみました。（現行のバージョン1は全く触れたことがありません） Prismaprisma/prisma2Prisma2についてREADMEによると Prisma2 は以下のツールで構成されます。 Prisma Client JS: Type-safe and auto-generated database client (“ORM replacement”)Pr

GiFTで2019年に利用した技術やサービスの感想まとめ2020.01.29 2019年の振り返りとして社内のプロジェクトや各個人で使った技術・ツール・サービスをまとめつつ、良かったところやそうじゃなかったところをみんなでそれぞれ挙げてみました。 概要職域ごとに分けてご紹介します。 ディレクション編デザイン編フロントエンド編バックエンド編その他編ディレクション編AsanaZenHubを使ってたZenHubリポジトリに紐づくのが単純に便利かんばんはステータス管理にとても便利だが、設定するプロパティが多く、扱いが難しくなってしまうこともあったつい直接GitHubのIssueを見てしまうInstaganttガントチャートツールとしては、現状一番ちょうど良い機能でも日本語入力だったりが少し残念なときもあるMiroさくっと作れるうえに高機能でUIも使いやすいただ、なんでも出来てしまうのでどのタイミン

デザイナーが思うLP制作でSTUDIOを使う5つのメリット2020.01.16 HTMLやCSS, JSでマークアップするのではなく、ウェブサービス上のGUIでウェブサイトをつくることができる"STUDIO"というサービスを触ってみたので感想をまとめました。マークアップまで担当するデザイナー、という目線で面白かった部分にフォーカスしています。 STUDIOについてなにも知らない！という方はこちらの公式から。 この手の似たサービスには、WixやSquarespaceなどがありますね。その中でも国産の分かりやすいサービスとして話題になっています。 僕の中では、コードを書かずにウェブサイトを作れる = コードの中身について気にしない、というのが今までのビルダーの考え方だったと思っていて、吐き出されるHTMLについては目をつぶるもの、という認識でした。要素の位置とか配置はposition:abso

Laravelのfactoryのinsertを改善してテストの効率化をした2019.12.24 Laravelのfactoryによるデータ作成を効率化させて、seederで時間がかかっていた部分を改善した内容について書きました。 環境Laravel 5系Laravelのfactoryは強力で、階層構造を持ったデータも直感的な記述で作成することができます。ですが、1件ずつinsertが発行されてしまう為、少し注意が必要です。 // usersを5件つくる factory(User::class, 3) ->create() ->each(function (User $user) { // ordersを5件つくる factory(Order::class, 5) ->create(['user_id' => $user->id]) ->each(function (Order $order

SchemaSpyのメタ情報をYAMLで書く2019.12.23 SchemaSpyにメタ情報を追加するmeta.xmlをYAMLで書いてから生成するようにしてみた。 プロジェクト内でデータベースの構造をシェアするためによく SchemaSpy を使うのですが、新しいメンバーやクライアントに見てもらうにはコメントがないと読み解いてもらうのは簡単ではありません。 SchemaSpyこれについて、SchemaSpyではデーターベースに直接情報がなくても追加でXMLファイルを記述すればテーブルやカラムに対してコメントを追加することができます。 Additional dataSchemaMetaこのXMLファイル自体はそんなに複雑ではないものの書くのか若干面倒だなと思っていたので、YAMLで同等の情報を書いてそれを元に生成するようにしてみました。 セットアップ以下の手順はRailsプロジェクトで動