OpenAPI

はじめに 最近、APIのバージョニングについて考えることがあったので自分なりに調べたことを下記にまとめる。 APIにバージョンを含めるメリット・デメリット メリット クライアント側が特定のバージョンを指定してアクセスすることができるので、クライアント側がバージョンアップに伴い仕様変更やバージョンアップによるエラーが発生しなくなる。 デメリット 複数バージョンを並列稼働させるため、ソースコードやデータベースの管理が分岐される。サーバーのコストと各バージョンを運用・テストするコストがかかる ＜所感＞ 広く世間一般に公開するようなサービスを展開するのであれば、利用者の利便性を考慮してAPIバージョン…

この記事について go-swagger について swagger 周辺ツールを使う際の注意点 最新の Swagger Specification に対応しているかどうか 生成される成果物の質に関するリスク Swagger 依存が高すぎないかどうか まとめ この記事について 僕は、go-swagger を使ったことはありませんが、 swagger （OpenAPI）とその周辺ツール（code generator）は死ぬほど使ってきました。 swagger を使うメリットや注意点についてはわかっているつもりです。 先日、「go-swagger ってどうなの？」と聞かれたので、その時思ったことを書き…

GraphQLにおける graphql-codegen のような、 OpenAPI のSpecification から TypeScript の型定義を作ってくれる swagger-to-ts を触ってみました。 github.com まとめ VSCodeの補完が効いてうれしい typoやパラメータの不足などのミスを防ぐ 使い方 型定義ファイルの生成 Shipments.v1.yaml という OpenAPI 3.0 Specification から、Shipments.ts という TypeScriptを生成します。 OpenAPI 3.0 Specification は YAML でも J…

OpenAPI の定義ファイルの作成と管理のためのツールを探していて、Stoplight Studio が良いと聞いたので試してみることにしました。 stoplight.io Stoplight Studio Stoplight Studio の触れ込み Next gen editor for API design & technical docs (API設計と技術文書のための次世代エディタ) Design APIs 10x faster with our free OpenAPI editor. Prototype and share your API within minutes. 無料…

SwaggerをGitHubで管理したい やりたいことまとめ どう実現するか 導入方法 OpenAPI 3.0 Specificationのファイルをdocs以下に置く GitHubにPushして確認 まとめ 参考 SwaggerをGitHubで管理したい SwaggerをGitHub(Git)で管理したい場合があるかと思います。 使い慣れている 変更点のレビューが出せる ソースコードとドキュメントを同じリポジトリで管理しておくことで、APIの仕様が変わった時にドキュメントの変更をし忘れる、ということが減る ただ、SwaggerをGitHubで管理することにに関してなかなか知見を得られませんで…

こんにちは、READYFORバックエンドエンジニアの森です。 花粉症シーズンの到来と共に、リモートのありがたさを感じています。 READYFORでは昨年約1年かけて、実行者さんの利用するプロジェクト管理画面のうち、プロジェクト編集画面のリニューアルを行いました。 この記事では、約1年に渡るリニューアルを、3つのチャレンジと共にダイジェストでお送りします。

Red Hatのソリューションアーキテクトの松田絵里奈です。 Red Hat にはクラウドネイティブアプリの開発に役立つ、ソフトウェアのラインナップが充実していることをご存知ですか？ ここでは、それらのソフトウェア [Red Hat Application Services]に関する注目ニュースを、各製品技術に特化したソリューションアーキテクトが、ご紹介します。 今回は 2021/3月号となります。 想定読者 エンタープライズアーキテクト アプリケーション開発者 システムの提案をするSIerの方 特集1: CodeReady Workspacesをカスタマイズして便利に開発してみよう その1 …

NSwag は NSwag.SwaggerGeneration.AzureFunctionsV2 が更新されておらず、V3ではエラーが出て動かなかったため、Swashbuckle を使用する。 目次 目次 検証環境 実装 参考 検証環境 Azure Functions v3 AzureExtensions.Swashbuckle v3.2.2 古いライブラリに注意 AzureFunctions.Extensions.Swashbuckle は更新されておらずエラーが出て動かない github.com 実装 NuGet でライブラリをインストールする。 Statup クラスを追加する。 usin…

はじめに はじめに 2つの開発手法 デザインファースト(トップダウン型) ①外部ユーザーに対して重要度の高いAPIを公開する場合 ②チーム間での開発コミュニケーションを重要視する場合 コードファースト(ボトムアップ型) ①素早く製品をリリースしたい場合 ②PrivateなAPIを開発する場合 まとめ 参考・引用 Swaggerを使ったAPI開発は、業務でも個人開発でもお世話になることが多いのですが、具体的な『開発手法』や『開発アプローチ』について考えたことがなかったので、調べてみました。 2つの開発手法 Swagger 公式Blogや、個人Blogの中には、開発手法に関して言及しているものがい…

REST APIで対象の項目にデータが無い時の表現方法が分からなかったので纏めました。 大きくは2つ、派閥があります。 null undefined データ項目を定義しない null派閥 RFC8259でJSONが定義されています。 JSONの値としては、オブジェクト、配列、数値、文字列、またはfalse, null, trueのいずれかである、と表現されています。 なので、データが存在しない場合はnullを指定するのがあるべきであると思います。 引用 RFC8259を引用。 3. Values A JSON value MUST be an object, array, number, or…

2021年2月5日に、READYFOR主催としては初となるオンライン技術勉強会、【実践！フロントエンド分離戦略】を開催しました！本記事では、当日の様子と各セッションの内容を振り返ってみたいと思います。 readyfor.connpass.com 当日は実に最大240人を超える視聴者が参加してくださり、Twitterでもご好評の声をいただきました。当日の様子はこちらのTogetterでも空気感が感じられると思うので、ぜひご覧になってみてください。 togetter.com 1. READYFORのフロントエンドを2019年末から全体像を構想してどうしていくか検討した話 まずはフロントエンドチー…

皆様初めまして。システム事業部の吉成です。 このブログに初めて投稿させていただきます。 今回はタイトルにもある通り、 業務で初めて使うことになったSwagger(OpenAPI)を使ってみた感想を書いていこうと思います。 Swagger(OpenAPI)について Swagger(OpenAPI)とはどういうものか、ほんの少しだけ軽く説明しようと思います。 Swagger(OpenAPI)とは？ Swaggerとは、RESTful APIを定義するためのオープンソースのフレームワークです。 Swagger SpecやSwagger Editer等のツールが提供されています。 Swagger Sp…

はじめに AppSheetを使うと、本当に簡単にノーコードでアプリを開発できます。ただ、手元のスプレッドシートを活用する個人用ではなく、企業内で統制をとりながら本格的に業務利用するには、API呼び出しによるビジネスロジックとの連携が必要になるでしょう。 ということで、最近正式にサポートされたApigeeによるREST連携が、どんな感じで使えるのか試してみました。 おそらくもっともシンプルな手順になっているかと思いますので、手短にAppSheet＋Apigeeの動作検証してみたい方がいらっしゃれば、参考にしてみてください。

AWS Lambda では、（Lambda 関数の）ランタイムがランタイム API（ランタイムインターフェース）から呼び出しイベントを受け取って、関数ハンドラーを実行し、その結果をランタイム API へ返すような流れで処理が実施されているようです。 AWS Lambda 実行環境 AWS Lambda ランタイム API そこで、自作のランタイム API サーバーを使って、Go と Node.js でそれぞれ実装した AWS Lambda の関数ハンドラーを（Docker 等を使わずに）ローカル実行してみました。 ソースは http://github.com/fits/try_samples/…

例えば以下のようなschemaがあるとする。このperson中のfather,motherは同じschemaのpersonを参照する形になっている。 { "components": { "schemas": { "person": { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" }, "father": { "$ref": "#/components/schemas/person" }, "mother": { "$ref": "#/components/s…

こんにちは。 DSOC R&D グループの高橋寛治です。 私は Python で WebAPI を開発する際には、Flask をよく利用しています。 最近は、FastAPI がいいらしいという話を同僚から聞くようになりました。 少し公式ドキュメントを覗いてみると、Flask をより便利に高機能にしたものに感じました。 これは使わねばと思い、開発環境の構築からテストまでやってみたため、ここで紹介します。 （しっかり理解したい場合は、充実した公式のチュートリアルがおすすめです。ドキュメントがしっかり整備されています。）

こんにちは、プラットフォーム技術戦略室の和田です。 このたび、OPTiM Cloud IoT OSを利用するためのツールのOSS公開をはじめました。今回は、その経緯と、作成したOSS公開チェックリスト（第１版）をご紹介します。 経緯 OPTiMでは、AI・IoT・Robotics活用プラットフォームサービスである「OPTiM Cloud IoT OS」（以下 CIOS）を提供しています。 www.optim.cloud CIOSは、弊社が提供している各種AI/IoTサービスの共通基盤です。 また、CIOSはOEMとしてもご提供しており、OEMしたプラットフォーム上で各産業向けのキラーアプリケー…