OpenAPI

GMOメイクショップコアグループの原田です。フロントエンドとバックエンド間のREST APIやり取りに型定義が無いという課題があったため、OpenAPIドキュメントを作成、それを元にした型定義をフロントエンドで利用できるようにしました。今回は、OpenAPIドキュメントを書くために利用したTypeSpecをご紹介します。

spectral は OpenAPI、AsyncAPI、JSON Schema などの API ドキュメントを検証するためのツールです。 今回は spectral を使用して OpenAPI の required フィールドを検証するカスタム関数を作成する方法について解説します。 【今回防ぎたいケース】 components: schemas: Me: type: object required: ... # typo により properties に存在しないフィールドが指定されてしまっている。 # # build-in rulesets を extends した # 『['spectral…

はじめに 今回はogenに限った話しというよりか、GoにおいてOpenAPIのコード生成を使った実装に関する感想になりますのでご留意ください。 コードの自動生成ができると何がいいのかというのは以下の通りです。 ただの作業になりがちなモデルの作成が自動化できる 仕様書通りにモデルや API インターフェースが自動生成されるので、バグが入りにくい 仕様書通りのリクエスト・レスポンスかどうかを簡単にバリデーションできる その結果、ビジネスロジックに集中する開発ができる 出典：[Go] OpenAPI コード自動生成でビジネスロジックに集中する開発へ #echo - Qiita 導入背景 現在参画して…

UPSIDERでエンジニアをしている太田です。 (@Hide55832241) この記事ではZodとOpenAPI Generatorを使用し、日付文字列をBrand型で扱う方法について紹介します。 TypeScriptを使用したフロントエンドのアプリケーション開発で日付をstring型で扱う際に困ることがあります。 日付をstring型として扱う際、APIから返却された未フォーマットの文字列と、UI用にフォーマットされた文字列を区別することが難しく、誤った表示や変換処理が発生しがちです。 またAPIリクエストでは正しいフォーマットで送信されているかどうかを保証できないため、不具合の原因になる…

はじめに vermeer.hatenablog.jp でOpenAPI（MicroProfile）の実装をしてみましたが、もう少し楽ができるようにしたいと思いました。 かといって実装そのものを拡張したり大がかりなものをつくるほどでも無い「程よい程度に」拡張をしてみました。 はじめに 拡張ポイント プロジェクト全体の定義 オブジェクトのSchemaを追加 なにがうれしいか 実装 @ExampleObjectにjsonを指定 なにがうれしいか 実装 モックとしてjsonを使用する なにがうれしいか 実装 Code さいごに 拡張ポイント プロジェクト全体の定義 OpenApiModelReader…

こんにちは、エキサイト株式会社の平石です。 今回は、OpenAPI Generatorで自動生成したAPIクライアントをコンパイルせずに利用する方法をご紹介します。 はじめに 環境 手順 1. これまでの方法で一旦生成する 2. 生成したファイルを実行するために必要な依存関係を確認する 3. 依存関係を自身で管理するbuild.gradleに追加する 4. OpenAPI Generatorの設定を確認、適宜変更し再生成する 5. 不要なファイルを削除する 動作確認 終わりに 参考文献 はじめに OpenAPI Generatorと、Javaでの基本的な利用方法は以下のブログをご覧ください。 …

新規プロダクトのリポジトリ構成にモノレポを採用してみた お久しぶりです，DELISH KITCHEN開発部でSoftware Engineer(SE)をしている鈴木です． every Tech Blog Advent Calendar 2024(夏) の15日目を担当する事になりましたので，鈴木が開発に携わっている新規プロダクトで採用しているリポジトリ構成についてお話させていただきます． はじめに 私事ですが，夏の兆しを感じ始めたタイミングでトモニテ開発部からDELISH KITCHEN開発部に異動しました． 異動後も新規プロダクトの開発に携わっており，有り難いことに大部分を任せていただいてい…

AzureのAI TranslatorとGPTsを使って、簡単にドキュメントを多言語に翻訳する方法を紹介します。 Azure AI Translatorを使うと、ドキュメントのレイアウトを変更せずに多言語に変換できます。また、GPTsを使ってAzureのリソースと連携させることで、さらに便利に利用できます。 この記事では、Azure AI TranslatorやAzure Web Appsのデプロイ、GPTsの設定方法について説明します。 Azure AI Translatorとは？ システムの動作結果 システムの連携図 作業概要 作業手順 Azure AI Translatorをデプロイ A…

2024/11/16 https://kansai.tskaigi.org/ TypeScriptの型システムは万能機械の夢を見るか？ canalun(かなるん)さん https://docs.google.com/presentation/d/1hnvPiSCI2UBIZ0x5OTl3ZFHvIGMIl3g37It1_Qd7hNA/edit 型システム 型システムでどこまで複雑な処理を解けるか 有限オートマトン booleanで返す問題を解ける チューリングマシン スタックを無限に伸びるテープにする アルゴリズムを実現できる これを超える仕組みはない TSの型システムでチューリングマシンを実…

.NET Conf 2024 のどのセッションを観るかを考えるためのセッションリストのメモです。 元のセッションリストはこちらです。 www.dotnetconf.net あまりにもセッションが多いので英語だと目が滑るので、概要を日本語にしました。 どうも日ごとに巨大なライブ配信のようなので、日ごとの想定開始位置も算出しました。 リストが巨大すぎるので、目についたワードをタグとして抽出してみました。 日 時刻 累計 時間 タイトル 概要 タグ 11月13日 01:00 00:00 60 分 Keynote - Welcome to .NET 9 .NET 9が登場し、クラウドネイティブおよびイ…

なぜAPIにフィルタリング機能が必要になるのか Webサービスを運営している時に、サーバサイドではAPIにフィルタリング機能を求められる事がしばしば起こります。このようなAPIの一例として、タスク管理ツールでのタスクの一覧を返す以下のようなAPIがあります。 openapi: 3.0.1 info: title: OpenAPI definition version: v0 servers: - url: http://localhost:8080 description: Generated server url paths: /tasks: get: tags: - tasks-contr…

はじめに 前提となるマインドセット 具体的な Tips コードを読まずに理解する技術 とりあえず Clone する インタフェースで理解する テストコードで理解する 慣習名で理解する コードの詳細を理解する技術 デバッガを使う とりあえずサンプルコードを書いてみる 分からないなら聞く 初見コードに安全に変更を加える技術 インタフェースを明らかにする Stub としての実装を用意する Design Doc を書く テストを書く まとめ We are hiring !! エンジニア採用ページはこちら カジュアル面談もお気軽にどうぞ インターンも常時募集しています はじめに 京都オフィス在籍で、AI…

はじめまして. Omni Hub チームでバックエンドを担当している shunten31 です. 最近親知らずを抜きました. 会社のテックブログを書くのは今回が初めてです. 約8ヶ月前に入社したのですが､入社後 Bruno という API クライアントを開発フローに導入したので､その話をしようと思います. 背景 Omni Hub ではプラットフォーム間のデータ連携を行っているというシステムの特性上､ 外部サービスのAPI を多く使用しています. 他にも､システム間の通信のための API も有しており､ これらの API を動作確認やテストで叩く必要のあることが多いです. しかし、これまでAPI…

はじめに Kotlinを使った事は全然無いですが、過去のLTテーマで発表された「これどうやって動いてるんだ？ Spring Framework/Bootのソースを読む」や「Kotlin向けOSSに貢献してきて感じたアレコレ」の資料を読んだことがありました。 これらの資料が非常に勉強になったのもあり、面白そうだったので初めて参加してみました。 参考リンク Server-Side Kotlin LT大会 vol.13 - connpass Server-Side Kotlin Meetup - connpass #serverside_kotlin_meetup - 検索 / X LT編 LTでは…

はじめに こんにちは、 SREのおかざきです。 エモーションテックでは、Azure OpenAI Serviceを活用したテキストAI分析サービス「TopicScan®︎」の開発を進めています。 本記事では、Azure OpenAI Serviceの負荷分散を実現するために設計したアーキテクチャと、その1年間の運用を踏まえての感想をご紹介します。 課題：増え続けるAzure OpenAI Serviceリソースへのアクセス方法 Azure OpenAI Service (以下、Azure OpenAI)には、TPM (Tokens-per-Minute) という利用制限(*1)があり、サブスク…

はじめに 「JJUG CCC 2024 Fall」に参加したのでメモや感想です。 ccc2024fall.java-users.jp 開催日時 2024年10月27日 10時〜 場所 ベルサール新宿グランド コンファレンスセンター www.bellesalle.co.jp 参加セッションとメモ＆感想 「オニオンアーキテクチャで実現した本質課題を解決するインフラ移行の実例」 レイヤードアーキテクチャの欠点->オニオンアーキテクチャ採用の流れがわかりやすかった インフラ層をビジネスロジックから独立させることで、インフラ層だけで変更ができ、並行して進めるビジネスロジックの開発とコンフリクトを防げる …

2024/10/27(日)にJJUG CCC 2024 Fallが行われます。 ccc2024fall.java-users.jp ↓参加登録はこちらです jjug.doorkeeper.jp 私は前回に引き続き、当日スタッフ、登壇を行いますが、せっかくなので初参加やJava歴が浅い方でも参加しやすいようにセッション詳細に出てくる技術系の単語を総ざらいます。 これにより、当日のセッション選びや事前勉強の助けになればと思います。 JJUG CCCとは ジェネリクス OpenAPI ドメイン駆動設計 Kotlin オブジェクト指向プログラミング Spring Spring boot Mutatio…

Redocly CLI の lint 機能 (redocly lint コマンド) を使うと OpenAPI の静的解析ができる👌 今回は redocly lint コマンドを GitHub Actions に組み込んで OpenAPI の静的解析を実行できるようにしてみた ＼( 'ω')／ redocly.com OpenAPI サンプル 今回は Petstore (OpenAPI 3.0) を Swagger サイトからダウンロードして使う🐶🐱 petstore3.swagger.io Redocly CLI まず redocly lint コマンドを実行するとエラー（10件）と警告（13…