OpenAPI や Protocol Buffers のおかげで開発がかなり捗っている話 | MEDLEY Developer Portal

2020-08-21OpenAPI や Protocol Buffers のおかげで開発がかなり捗っている話こんにちは、インキュベーション本部エンジニアの加藤です。 主に CLINICS アプリの開発を担当しています。 はじめにCLINICS アプリの開発では OpenAPI や gRPC を利用しています。 OpenAPI と gRPC の間には何の関係もないのですが、どちらも API の仕様をスキーマ言語で記述するという点では共通しています。 今回はこの API スキーマが開発にもたらすメリットについて紹介していこうと思います。 API ドキュメントとしてのスキーマ定義既存のコードに機能を追加する際や修正を加える際に気にすることの多い部分は API の仕様ではないかと思います。 「リクエストやレスポンスはどのようなデータなのか」「この値は必須なのか、任意なのか」「データの型は数値なのか

[shrkw]

openapi-generatorはうちも使ってるけど未対応のissue,prの多さ、未実装の多さ、開発リソースの逼迫、コードの統制のとれてなさに言及しないのはフェアじゃない。ホントに活用してる？

[stk132]

ワイjson色付け係と返却係両方やってるので、API先に実装してからopenapi定義書いて、そこからtsのクライアントを自動生成してる。

[tsuwatch]

openapi-generator、Rubyで使ってるけど、あまり使いこんでない人が多いのか目を瞑ってるのかわかりませんが、未実装の仕様があったりして諦めが発生したりします

[getcha]

社内でスキーマベースの話になって、SOAPでWSDL書いてた時代に戻ろうとしてるのかも。みたいな話になった。普通に構造体作ってシリアライズしても（しなくても）簡単で、工夫もできるし不便ではないんだよね。

[lizy]

そういえばCORBAとかDCOM時代のIDLはなんで廃れたんだろう

[hirokinko]

yamlやjsonでspec書くにしてもopenapi-generatorがmustache使ってることで微妙にカスタマイズの融通が効かないと感じるし、コードからspec生成するにしても言語やフレームワークに引きずられてしんどい時あるのが悩ましい。

[stibbar]

https://qiita.com/yugui/items/160737021d25d761b353

[harabu]

はかどると言うよりも、うまくいっているように見せられる。決まってないことがあったりすると後から変な動作になる、といったことは起きると思われるのです。捗る点がタイトルにあるといいのかもしれない・・・

[hylom]

OpenAPIもProtobufもプログラム言語による実装レベルがだいぶ違うので言語によっては結構手間がかかったりするのが辛いところではある

[laiso]

自前ジェネレーターやったことなかった。試してみようかな

[eagleyama]

“OpenAPI は REST API のインターフェースを記述する仕様です。 エンドポイントのリクエストパラメータやレスポンスの構造などを JSON や YAML で記述していくことができま”

[hirose504]

OpenAPIでAPIレスポンスを検査して、TypeScriptの型を生成してくれるようなものが欲しい

[Keisuke69]

OpenAPIネタもう一発

[Layzie]

弊社のエンジニア加藤が、OpenAPIとProtocol Buffersを使っての開発メリットについて書いてくれましたー!