OpenAPI

English article is here: openapi-fetch-gen – Generate TypeScript API client from OpenAPI TypeScript interface definitions created by openapi-typescript - DEV Communitynpm registryにも公開されています。従って以下のようにダウンロード可能です。 npm install @moznion/openapi-fetch-gen これは何 / 背景 OpenAPI 3の仕様からopenapi-ts/openapi-typescr…

こんにちは、エキサイト株式会社の平石です。 エキサイトホールディングス Advent Calendar 2024の10日目を担当いたします。 Springdocライブラリを利用することで、簡単にOpenAPI仕様に則ったAPIドキュメントを自動生成することができます。 しかし、このライブラリを使って開発を行う中で、APIのパラメータをどのように認識しているのか少し気になったので、その調査をしてみました。 今回は、その内容をブログとして残したいと思います。 なお、今回紹介するのはspringdoc-openapi v2.7.0での動作であり、今後変更される可能性はありますのでご注意ください。 共…

この記事は every Tech Blog Advent Calendar 2024 1 日目の記事です。 はじめに 現状の管理方法からの問題点 分割の手段 分割によるメリット・デメリット まとめ 最後に はじめに こんにちは、トモニテ開発部ソフトウェアエンジニア兼、CTO 室 Dev Enable グループの rymiyamoto です。 Advent Calendar のトップバッターを務めさせていただきます！ 今回は OpenAPI でスキーマ駆動開発をしていく上での定義ファイルの管理方法についてお話できればと思います。 元々別の新規プロダクトで採用されていた分割方法をトモニテでも取り入…

はじめに こんにちは、ecbeingのカミーユです！ 早くも2024年度も半分が過ぎ、毎年 時が過ぎるのが早くなっているなぁと感じる今日この頃です。 さて、世の中はAIブーム真っ只中。 弊 ecbeing labs でもAI系の話題が取り上げられるようになりました。 しかし、前回に引き続きまして OpenAPI についてのプロダクトを取り上げたいと思います。 OpenAIのAPIの仕様もOpenAPI仕様で策定されていますし、名前も似てるので実質AIの話題ですよAI（強引） 冗談はさておき、今回は Microsoftが2023年に発表した OpenAPI クライアント作成ツール Kiota の…

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 導入背景 現在参画して…