OpenAPI (Swagger) 形式のyamlからrequestBody/responsesのサンプルJSONを出力する - Qiita
OpenAPI (Swagger) 形式のyamlからrequestBody/responsesのサンプルJSONを出力するNode.jsJSONYAMLswaggerOpenAPI はじめに ユニットテストとかを書くためにAPIのリクエストとレスポンスがJSON形式で欲しいとなったときに、今まではOpenAPIドキュメントをReDocで表示してそこに載っているサンプルをコピー＆JSON形式で保存し直すみたいなことをしていました。 ただしこの方法は、APIの数が増えてきてかつ変更もちょくちょくあるような場合だと結構面倒な作業ですし、CIにも組み込みにくいです。 わざわざこの画面を経由しないでもOpenAPIドキュメントのyamlからこのrequestBody/responsesだけを直接JSONで吐き出す方法は何か無いものかと色々調べてみたのですが、元のOpenAPIドキュメントをyaml
はじめに Another works サーバサイドエンジニアの釜地です！ みなさんOpenAPI(Swagger)は使用されていますか？ 本記事ではOpenAPIを導入するに当たって、合わせて利用して便利だったツールを紹介したいと思います。 そもそもOpenAPI(Swagger)とは？ OpenAPI仕様（以下OAS）と言われるREST APIを定義するための標準仕様にもとづいて構築された一連のオープンソースツールです。 REST APIの設計、構築、文書化、および使用に役立つ機能を提供します。 弊社の課題感 現状、フロントとサーバを分業制で開発している上で下記のような課題がありました。 APIの伝達がJiraのドキュメントであり、フォーマットが統一されず作成するたびに若干書き方が変わる API仕様が蓄積されていかない → 開発チームが大きくなったときのために今の内からドキュメントを残し
スキーマ駆動開発とは 簡単に言うと、先にAPIのスキーマ (request, responseの型やフィールド名の定義)を決め、それに伴ったドキュメントとモックの生成をシステマティックに行った上で内部の実装を行う開発手法です。(参考: チームのWeb API開発を最適化するSchema Driven Developmentの解説＆実装例) pythonのwebフレームワークであるresponderでスキーマ駆動開発をやってみたいと思います。 以下の様なSwaggerが見れるようになるのがゴールです。 responder PythonのモダンなWeb フレームワークです。 ボリューム感的にはflaskやbottleのようなマイクロフレームワークです。 以下の様に書いて、$ python xxx.py のように実行するだけで、JSONを返すAPI serverが起動します。 import re
フロントエンド開発のためにモックサーバーを使いたかった フロントエンドのAPI実装をするにあたって、モックサーバーを作るためのツールを検索していたら、API仕様書作成ツールのSwaggerのサードパーティ製ライブラリのSwagger Studioで作成した仕様書のモックサーバーを簡単に利用できることを知った。 元々モックサーバー用のライブラリであるPrismが統合されているらしい。 GUIで直感的にAPI定義できる SwaggerではAPI仕様書をyamlファイルを書いて作成していくが、Swagger Studioを利用するとGUIで直感的に操作して定義を作成しそのコードを出力することができる。 実際に操作してみる まずアカウントを作成ます。 API Design & Documentation Management | Designing & Building OpenAPIs 自分のワ
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Stoplightの使用感がかなり良かった話(OpenAPI,Swagger) - Qiita
Responderでスキーマ駆動開発: Swagger UIの表示までやってみる - Qiita
Swagger StudioでAPI仕様書の作成とモックサーバー利用してみた - Qiita