You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
サーバーサイドエンジニアの田実です！ Yappliのネイティブアプリ向けのAPIは一部gRPC-Gatewayで実装されています。 インターフェース仕様の共有・確認はprotoファイルやwiki*1、Slackを使って行っていましたが、protoファイルだとリクエスト・レスポンスの全容が一見して把握しづらく、wikiやSlackだと反映漏れや最新の仕様が追いづらい等の課題がありました。 本記事ではこれらの課題を解決するために、Swaggerを使ってgRPC-GatewayのAPIドキュメントを自動生成した話を紹介したいと思います！ protocを使ってOpenAPIのドキュメントを自動生成 gRPC-Gatewayのprotoc-gen-openapiv2のプラグインを使うと、protoファイルからOpenAPIの定義ファイルを書き出せるようになります。 $ go get -u githu
こんにちは、サーバーサイドエンジニアの @kimihiro_n です。 最近は FastAPI という Python の Web フレームワークが社内で密かなブームとなっています。 今回はその FastAPI を使ったエラー定義まわりの話をしたいと思います。 FastAPI とは FastAPI の概要については先日ちょうど社内勉強会用に資料を作ったのでこちらを見てもらえるのが早いです。 ざっくり言えばシンプルなインターフェースとドキュメント(OpenAPI)の自動生成が強力なフレームワークになります。 OpenAPI でドキュメント管理 今回注目したいのはドキュメントの自動生成のほうです。 開発チームでもドキュメントとAPIの実際の仕様が一致しない問題が時々発生していて、どうドキュメントを管理していくかが課題となっています。 KPTで振り返った結果、「人がドキュメントを書くからメンテが大
目次 OpenAPIでドキュメントを書くメリットなど OpenAPI GeneratorでClient情報を吐き出す Vue, Nuxtで利用する APIの変更に追従しやすく、型もあるし幸せ OpenAPIでドキュメントを書くメリットなど 弊社では以下のブログでも書いているように、API仕様のドキュメント化にOpenAPIを活用しています。 committee×OpenAPI×RailsでスキーマファーストなAPI開発 OpenAPIのスキーマを分割・構造化していく方法 フロントエンドとバックエンドで実装する人が異なる場合、また、将来的に異なる人が実装する可能性がある場合や、単純に見やすいドキュメント作りという点で考えても、OpenAPIを利用するメリットは大きいと感じております。 そして、そのメリットを拡大してくれるなと感じているのが、OpenAPI Generatorを利用した開発です
マイクロサービスにおけるWeb APIスキーマの管理 ─ GraphQL、gRPC、OpenAPIの特徴と使いどころ マイクロサービスにおける通信方式の選択について、おおた（ota42y）さんが、GraphQL・gRPC・OpenAPIといった主なWeb APIスキーマの管理の利点と使い分けを解説します。 近年流行しているマイクロサービスアーキテクチャにおいては、「どういった通信方式を選ぶか」が開発の効率やサービスの信頼性、パフォーマンスを大きく左右します。この記事では、GraphQL・gRPC・OpenAPIそれぞれの利点と適切な使い分けについて解説します。 マイクロサービスにおけるWeb API管理の重要性 Schema First DevelopmentとWeb API 人ではなくプログラムが処理できるよう管理する Web APIのインタフェース定義手法の比較 OpenAPI ─ R
Prototype your API without writing any code.Prism is an open-source HTTP mock server that can emulate your API's behavior as if you already built it. Mock HTTP servers are generated from your OpenAPI v2/v3 documents. Iterate faster with early feedback.Embrace the power of early feedback by incorporating user input during the design phase of your API, rather than waiting until after the code is wri
こんにちは、インダストリー事業本部 医療チームの高橋（@yukey1031）です。 去年のクリスマス以来の投稿です。AMIAS（アミアス）をお願いします。 さて、今回は自身の周辺業務で普段行っているOpenAPIによるスキーマファースト開発の実施サンプルと先日Google Cloudより発表された「Cloud Run」について少し触れてみたいと思います。 なお、フロントエンドはVue.js+TypeScript+Axios、バックエンドはJava+SpringBootでの話です。 マイクロサービスな現場でのAPI開発 スキーマファースト開発 OpenAPI OpenAPI Generator Cloud Run 実施サンプル Requirement インターフェイス定義 サーバーサイド実装 フロントエンド実装 Cloud Runにデプロイ／接続 おわりに マイクロサービスな現場でのAPI開
You can add examples to parameters, properties and objects to make OpenAPI specification of your web service clearer. Examples can be read by tools and libraries that process your API in some way. For example, an API mocking tool can use sample values to generate mock requests. You can specify examples for objects, individual properties and operation parameters. To specify an example, you use the
A Visual Guide to What’s New in Swagger 3.0 Over the past few years, Swagger 2 has become the de facto standard for defining or documenting your API. Since then, it’s been moved to the Linux foundation and renamed to OpenAPI Spec. Version 3 has been in the works for a while, and it’s finally feature complete! Here’s a guide to what’s changed, and how to upgrade from Swagger 2 to OpenAPI 3. Like Sw
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
