GitHub - rswag/rswag: Seamlessly adds a Swagger to Rails-based API's
OpenApi 3.0 and Swagger 2.0 compatible! Seeking maintainers! Got a pet-bug that needs fixing? Just let us know in your issue/pr that you'd like to step up to help. Rswag extends rspec-rails "request specs" with a Swagger-based DSL for describing and testing API operations. You describe your API operations with a succinct, intuitive syntax, and it automatically runs the tests. Once you have green t
gRPC, grpc-gatewayで作るダミーAPIサーバー - Qiita
というのをふと思いついたのでメモ程度に残しておく。あとからサンプルコードとともにちゃんと公開する それぞれの課題 フロントエンドエンジニア/デザイナーの課題 APIサーバーを叩く必要があって必要なJSONがほしい サーバーサイドの実装が待ちになると生産性が低い APIの仕様が変わる場合早く知らせてほしい Swagger ドキュメントの課題 実装とドキュメントの乖離が起きがち Swaggerには書かれてるけどまだ実装が終わっていない 実装は終わってるがSwaggerが更新漏れしていた サーバーサイドエンジニアの課題 APIの仕様が変わると実装のvalidationなどの変更が面倒 サーバーサイド実装作ってみて、フロントエンドに渡したあとで仕様変更が発覚した 課題 ドキュメントと実装の乖離は少なくしたい フロントエンドとサーバーサイド分けて実装したい gRPC + grpc-gateway h
OpenAPIのschema定義からRubyのクラスを生成するgem「openapi2ruby」をつくりました - ZOZO TECH BLOG
こんにちは。スタートトゥデイテクノロジーズ新事業創造部のid:takanamitoです。 今日はVASILY時代から活用されているOpenAPI(Swagger)の定義からRubyのクラスを自動生成するgemを作ったので、その紹介をしようと思います。 Swaggerの定義と実際のAPIが返すレスポンスの内容がズレている 弊社ではVASILY時代からSwaggerの導入が進んでいましたが、徐々に「Swaggerの定義と実際のAPIが返すレスポンスの内容がズレている」といった問題が発生しはじめていました。 その問題を解決するために今回つくったのがこのgemです。 github.com 例えばこんなOpenAPI Specification 3.0のYAMLの定義から schemas: user: type: object properties: username: type: string u
Rails + swagger-blocks で OpenAPI 形式の API ドキュメントを作成する
この記事では、Rails で書いた JSON API サーバそれ自体の API エンドポイント仕様ドキュメントを OpenAPI 形式の JSON データとして生成し、そのデータを API 自体から取得する方法を説明します。 つまり、次のようなエンドポイント { "swagger": "2.0", "info": { "version": "1.0.0", "title": "Sample App", "description": "This is a sample app.", "contact": { "name": "@kymmt90" }, "license": { "name": "MIT" } }, // ... "paths": { "/users": { "post": { "description": "Creates a user", "operationId": "c
Swagger+JSON SchemaでAPIの型をテストして開発サイクルをスピードアップさせた話 - pixiv inside
CTO兼福岡オフィス立ち上げ担当として新アプリを作っている@edvakfです。 JSON APIを開発しているとこういう問題がありがちですよね。 仕様どおりにAPIの形式を作ったはずだけどなんか自信が持てない テストでいくつかのキーが存在するかの簡単なチェックはしてるつもりだけど、全部チェックするのは大変すぎる APIのControllerやViewをリファクタリングしたらレスポンスの形が変わってアプリがめっちゃクラッシュし始めた というのが怖くて誰もリファクタリングできなくなった APIドキュメントがメンテされない 知らない間にレスポンスのフィールドが増えてたけどドキュメントに書いてない これらを解決したい！と思って試行錯誤したら、スマートに解決することができました。この記事ではRailsのことについて書きますが、考え方は他の言語・フレームワークでも同じです。 なお、今回使ったgemのバ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - Narazaka/swagger-serializer: Swagger (OpenAPI 3) schema based serializer for ruby
Viron · Automated admin tool
GitHub - fotinakis/swagger-blocks: Define and serve live-updating Swagger JSON for Ruby apps.