スキーマ定義言語 Protocol Buffers と protoc-gen-swagger を使って Web API のスキマを埋めよう - VOYAGE GROUP techlog
VOYAGE Lighthouse Studio の海老原 (@co3k) です。先日 30 歳になった記念としてタイトルはオヤジギャグです。 さて、普段は 神ゲー攻略 というゲーム攻略サイトを運営しているのですが、とある派生サービスを立ち上げるにあたり、 Web API スキーマ定義を gRPC に基づく形式の Protocol Buffers で書き、 protoc-gen-swagger プラグインを介して OpenAPI 定義ファイルとして生成する、というアプローチを採りました。 yugui さんの素晴らしい記事、「今さらProtocol Buffersと、手に馴染む道具の話」によってスキーマ定義言語としての Protocol Buffers がにわかに注目を浴びて以降、似たようなことをやりたいという方もいらっしゃるのではないでしょうか。 ところが、おそらく単体で protoc-g
UI開発にSwaggerで作ったmockサーバーを使う | Fintan
こんにちは。西日本テクノロジー＆イノベーション室の藤田です。 日々（技術的に）強くなりたいと言っている新卒3年目です。 弊社では名刺を入社した時に100枚、それ以降も部門名称が変わるたびに100枚ずつ支給されるのですが、入社してからもらった名刺は400枚になりました。来年には500枚になっているかもしれません。 この記事では、先日まで関わっていたサービス開発案件で蓄積されたノウハウとして、Swaggerで生成したmockサーバーを使ってUI開発をする流れを書いていきます。 背景 3人チームで新規サービスを開発していました。 APIはRuby on Rails、UIはReactを使っており、私はUI開発者として参画しました。 今回の開発では、API開発を待たずともUIの開発ができるよう、Swaggerを使って生成したmockサーバーを使ってUI開発を行いました。 ここではSwaggerを使っ
Swagger 定義ファイルから そこそこいい感じの静的 REST API ドキュメント作成する - Witch on the Other Shore
REST API のドキュメンテーションはサービス開発における課題として認知されており、解決に向け近年さまざまな試みが行われています。OPEN API および Swagger はその有力な動きの1つです。 長いものには巻かれろ (?) ということで、今回は Swagger 定義ファイルをベースとした REST API ドキュメントの生成方法をまとめます。 結論 swagger2markup-cli と asciidoctor を組み合わせて HTML ファイルを生成するのがよさそうです。 課題の共有 Swggger 定義ファイルからドキュメントを生成する手順はいくつか存在します。 swagger-ui を利用する swagger-codegen で HTML を出力する swagger-ui はリッチで美しいドキュメントを提供してくれます。しかしインタラクティブな API ドキュメントが必
Swagger定義ファイルを分割する | DevelopersIO
Swagger用ファイルを分割して記述しよう Swaggerとは Swaggerとは言語に依存しないREST APIのインターフェース仕様とそれに関連するツール/ライブラリのことです。 RESTful APIの記述標準化を目指している、MS/Google/IBMなどが参加しているグループ、 Open API Initiativeでは、APIの記述のためにSwaggerが採用されています。 Swaggerは以下のようなツールから構成されています。 Swagger UI - swagger specをパースしてAPIドキュメント化するツール Swagger Codegen - swaggerの定義ファイルからプログラムコードを生成するツール Swagger Editor - オンラインで使用できるSwaggerエディタ 普通にswaggerの記述をする まずは下記のように、普通にswagger
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - OpenAPITools/openapi-generator: OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
