OpenAPI Generatorに適したOpenAPIの書き方 - ZOZO TECH BLOG
はじめに こんにちは！ WEARバックエンドブロックの高久です。 WEARではOpenAPI（Swagger）を使って、アプリやWebのクライアントが利用するAPIを定義しています。そして先日、開発効率化のためにOpenAPI GeneratorでOpenAPIからAPIクライアントコードを自動生成、活用できるように整備をしました。その中でOpenAPI Generatorに適したOpenAPIの書き方のポイントがいくつかあったので、内容を紹介していきます。 想定読者 OpenAPIを現在利用している、またはこれから利用する予定の方 OpenAPI Generatorを利用したコード自動生成を検討している方 背景 当初WEARではAPIクライアントコードはOpenAPIでのAPI定義を基に各クライアントが手動で実装していました。しかし手動で実装すると初期の実装コストや変更時の追従コストがか
API 設計: gRPC、OpenAPI、REST の概要と、それらを使用するタイミングを理解する | Google Cloud 公式ブログ
※この投稿は米国時間 2020 年 4 月 11 日に、Google Cloud blog に投稿されたものの抄訳です。 ほとんどのソフトウェア デベロッパーがご存じだと思いますが、API 設計には RPC と REST の 2 つの主要なモデルがあります。モデルに関係なく、ほとんどのモダン API は、なんらかの方法で同じ HTTP プロトコルにマッピングすることによって実装されます。また、RPC API 設計では、RPC モデルの範囲から外れずに HTTP から 1 つまたは 2 つのアイデアを採用することが一般的になっています。これにより、API 設計者に提示されるオプションの範囲が広がりました。この投稿ではこれらのオプションについて説明し、どれを選ぶか決める際に役立つガイダンスを提供します。 gRPC は RPC API を実装するためのテクノロジーで、HTTP 2.0 をその基盤
OpenAPI や Protocol Buffers のおかげで開発がかなり捗っている話 | MEDLEY Developer Portal
2020-08-21OpenAPI や Protocol Buffers のおかげで開発がかなり捗っている話こんにちは、インキュベーション本部エンジニアの加藤です。 主に CLINICS アプリの開発を担当しています。 はじめにCLINICS アプリの開発では OpenAPI や gRPC を利用しています。 OpenAPI と gRPC の間には何の関係もないのですが、どちらも API の仕様をスキーマ言語で記述するという点では共通しています。 今回はこの API スキーマが開発にもたらすメリットについて紹介していこうと思います。 API ドキュメントとしてのスキーマ定義既存のコードに機能を追加する際や修正を加える際に気にすることの多い部分は API の仕様ではないかと思います。 「リクエストやレスポンスはどのようなデータなのか」「この値は必須なのか、任意なのか」「データの型は数値なのか
スキーマファースト開発のススメ - onk.ninja
第 2 部 で 現在 5 派閥ぐらいありそうです。 と書いた中でなぜ OpenAPI を選んだのかというと、 JSON Hyper-Schema は Hypermedia の技術なので、1 サーバ 1 クライアント、同一チームで両方を見るという private API では出番が無い。 RAML はコミュニティ規模が OpenAPI, API Blueprint に比べて小さかった OpenAPI と API Blueprint、生 JSON Schema だと、OpenAPI が一番「RESTful API」に特化していて、かつ詳細度が高い といった辺りです。 OpenAPI は ruby だとライブラリが (当時は) 少なかったのですが、まぁ作れば何とかなるだろうと採用しました。 最近のトレンドでも Swagger 1 強になってるっぽくて、良い選択をしたなぁと思っています。 Open
RailsのAPI開発にスキーマ駆動開発を導入して、品質と開発スピードを高める - freee Developers Blog
こんにちは、freee API開発チームのkotegawaです。 この記事はfreee Developers Advent Calender 2018の19日目の記事です。 freeeのAPI開発 freeeでは今年の7月から、API開発専任チームが新設されました。 API開発チームでは、 社外向け新規APIの開発 API開発基盤の強化 新規プロダクトの開発 などの業務を社内の認証基盤チームやインフラチームと協力しながら行っています。 今日はAPIチーム発足前にfreeeが抱えていたAPIの課題と、それを解決するために導入したスキーマ駆動開発について紹介します。 APIチーム誕生前の課題 もともと弊社のAPIの課題として、以下のようなものがありました。 APIドキュメントと実際の実装に差異があった 開発する度にAPIドキュメントを更新することにメンテナンスコストがかかっており、また手動で更
OpenAPI の運用方法についてと、OpenAPIのメリット・デメリット - 猫でもわかるWeb開発・プログラミング
はじめに 自己紹介 （ゆるふわ）RESTの採用理由 OpenAPIを採用した理由 Confluence を使っていた OpenAPIを使おう OpenAPIとは OpenAPI の運用方法 リポジトリ ディレクトリ構造 コントリビュートとCI OpenAPI を採用してよかった点 慣れればすごく良い Code Generator が使える OpenAPI の辛い点 正確に書こうとするとかなり大変 ツールの質が微妙な時がある YAMLが巨大になると辛い 本当の意味でRESTになっていないと辛い ネットに知見があまり無い（気がする） まとめ はじめに この記事はドワンゴ Advent Calendar 2019の8日目の記事です。 qiita.com 自己紹介 ニコニコ動画とNicoBoxのサーバーサイドの開発をしています。最近はAPIサーバーを新しく作ったり、保守したりしています。 Nico
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
