本当に使ってよかったOpenAPI (Swagger) ツール | フューチャー技術ブログ
サードパーティ製のツール本家からは上述のツールが提供されていますが、サードバーティ製の様々なツールが世の中には存在します。 エコシステムが成熟しているのもSwaggerを利用するメリットの一つですね。 https://openapi.tools/ 冒頭のとおり、このサードパーティ製のツールの中で実際に利用して良かったツールを3つご紹介したいと思います。 Stoplight Studiohttps://stoplight.io/studio/ 1つ目のツールは「Stoplight Studio」というAPI仕様を記載するためのGUIエディタとなります。 今までSwagger Editorを利用してYAMLを書いていたそこのみなさん、YAML筋力はもう必要ありません。 Design APIs 10x faster の謳い文句どおり、Stoplight Studioを使えばGUIで直感的に、高速
はじめに 私の職場では、WebAPIの仕様書をWordで書く習慣があったのですが、2018年頃にSwaggerで書くように切り替わったので、そのように変化した経緯を書きます。 何かの参考になれば幸いです。 ちなみに、こちらの記事と同じ職場です。 Wordな職場にMarkdownを定着させるためにやった４つのこと Swaggerとは？ Swaggerとは、REST APIの仕様を定義するためのフォーマットです。その周辺技術も含めて、Swaggerと呼ばれます。以下の記事が非常に参考になりますので、詳細を知りたい方はご参照ください。 Swaggerの概要をまとめてみた。 Swagger 導入失敗 2016年頃のある日、上司から「世の中にはSwaggerというものがあるらしい。調べてもらえる？」と指示されました。 調べてみたところ、Swaggerがあれば、WebAPIのドキュメントサイトも作れる
Go(Echo), Gorm, Mysql, Docker, Swaggerで、クリーンアーキテクチャなAPIサーバーを作ったメモ
自分の本業は10年物のMVCプロジェクトなのでClean Architecture忘れがちです。 なので、慣れてるGoでパッとClean Architectureの復習を行ってみました（２年前にPythonでやった事はあるんだけど・・・）。 このスクラップでは単語とか作りどころとかを整理するのですが、また後でRustで作ってそっちは前例がほぼないので記事にします。 Go + Clean Architectureは結構記事あるんですが、Swaggerつけたしたのと自分なりに納得いくディレクトリ構成にオリジナリティを出しました。ちなみにgo-swagger使うと本当は凄く楽に作れるのですが(ついでにフロントはopenapi-generator)、今回はClean Architectureを理解するのが主目的なので、サーバーは手書きでopenapiのyamlも1から自作しました。 ↑ postに
はじめにこんにちは、Finatext で保険事業のプロダクト開発をしている @toshipon です。今回は以前の Fin-JAWS のイベントで少し紹介させていただいた、我々の現場で取り組んでいる、大規模API開発における Swagger を用いたAPI仕様のドキュメント運用方法について紹介いたします。 概要我々の現場では、API ベースのWeb Application を開発する際に、Swagger を用いて API 設計をしたり、BFFサーバー開発者やフロントエンド開発者とのコミュニケーション手段として活用しています。 ただし、Web Application の規模が大きくなってくると、Swagger の 定義ファイルは肥大化してしまい、メンテナンスが困難になってきます。 今回は、Web Application の規模が大きくなっても耐えうる Swagger 定義ファイルの運用方法を
はじめに 自分は実務でReact×TypeScriptを利用したフロント周りとNode.js(Nest)やRailsを用いたバックエンド(API)の開発をしています。 本記事では、OpenAPIを用いたAPI設計の書き方及び、Swaggerの説明と使い方についてまとめていきます。 この記事の対象者 プログラミング初心者から中級者 APIの基礎を理解している人 OpenAPIを用いてサクッとモックサーバーを試したい人 この記事の目標 モックサーバーの環境構築を学ぶ Swaggerの使い方を理解する OpenAPIを用いてAPI設計の具体的な書き方を学ぶ この記事でやらないこと 本記事ではOpenAPIの「書き方」をメインで解説するため、API設計についての細かい解説は省きます。 なおAPI設計については下記の記事でまとめているので、ぜひ参考にしてみてください。 用語解説 OpenAPI 公式
前回は「今日から始めるswagger入門」という最低限書けるようになっておいた方が良い物をこちらの記事で解説させてもらいました 今回は、筆者が4〜5年ほど現場で見てきたswaggerを元に、現場で必要になるswaggerの知識をまとめましたので、ぜひご覧になっていただけると嬉しいです！ タグ付け pathsに書かれている各APIendpointをタグ付けしてグルーピングする目的で使用されます 現場では大量のAPIendpointを設計していくこととなるので、多くなってくると大変見辛くなってきます それをグルーピングすることにより見やすくしようということです openapi: 3.0.3 info: title: test-api version: 0.0.1 # ここから tags: - name: user description: ユーザー情報 # ここまで paths: /users
スキーマファースト開発のためのOpenAPI（Swagger）設計規約 | フューチャー技術ブログ
はじめまして。TIG DXユニット 1の亀井です。 はじめに みなさん、Swagger使ってますか？ Swaggerや周辺ツールについては 某先輩の記事 にて丁寧に解説されていますので、 本記事では実際にSwaggerのスキーマ定義を設計していく上で取り決めた規約について書いてみたいと思います。 前提私が在籍しているプロジェクトでは、REST APIは golang でフロントエンドを Vue.js + TypeScript で構築しています。 短期間・高品質での構築を実現するためにSwaggerを設計ドキュメントとしてだけではなく、コード自動生成やモックサーバーに活用させることで徹底したスキーマファーストな開発を行ってきました。 というわけで、今回は下記のツールを利用することを前提として規約を作成しています。 go-swagger: Goアプリケーションのハンドラ、リクエスト/レスポンス
こんにちは。LINE Growth Technology福岡開発室でサーバーサイドエンジニアをしている中村です。 この記事では担当していたプロジェクトで実施した、Swaggerを使ったAPIドキュメントの作成と、BE（バックエンド）とFE（フロントエンド）間の連携について紹介します。 プロジェクトの説明 はじめに、今回LINE Growth Technology福岡開発室（以下「GT」）がシステムの設計開発を担当した、LINE公式アカウント審査ツールのプロジェクトについて説明します。 LINE公式アカウント審査ツールとは、LINE公式アカウントで認証済アカウントが申請された際に、申請内容が適切であるか審査するシステムです。 このシステムは、LINE公式アカウントが利用されている各国に存在する審査パートというチーム（以下「審査チーム」）によって利用され、日本以外の国家も含め、一日あたり平均約
go-swaggerを用いたWebアプリケーション開発Tips19選 | フューチャー技術ブログ
はじめにTIG DXユニット 1の真野です。echo → 生net/http → gorilla/mux → go-swagger, gqlgenの経歴でGoのHTTP APIを実装してきました。本記事では最近業務でヘビーユーズしているgo-swaggerについての開発Tipsをまとめました。 背景フューチャーではGoを採用する案件が増えて来ており、その際にgo-swagger というツールを利用することが多いです。 2 理由はWebAPIのスキーマを駆動に開発することに慣れているという開発文化（DBレイヤのERDやデータフローを駆動に開発することは今も多い）や、リリース後の保守や将来のマイグレーションを考慮しなるべく特定のDSLに依存したくないというポリシーを強く持つこと、開発前にある程度固く機能数を洗い出して工数見積もりや開発スケジュールに活かしたいといった大人な事情など、色々相性が良
Swagger ではない OpenAPI Specification 3.0 による API サーバー開発
JJUG CCC 2019 Fall の発表資料になります。 OpenAPI Generator を使って小規模な Web API サーバーを開発したときの経験やノウハウをまとめたものです。 https://ccc2019fall.java-users.jp/ https://jjug-cfp.cfapps.io/submissions/92e3117f-d911-4674-b97b-581813cfa0dcRead less
swaggerとは 古の時代、API仕様書はwordやexcelで表現され、各所に共有されるというのが一般的でした。 ですが近年、API仕様を表現する際にはswaggerを利用するのが最も効率的で、保守性が高く、世間一般で仕様化され、見やすいというのもあり、一般化されてきたのではないのでしょうか 今回はそんなswaggerの書き方について、まずは書くために覚えておきたいポイントを解説していこうかと思います！ どう書いてくか swagger editorで書く 公式がWeb上に提供しているツールを利用し、すぐにでもswaggerの執筆が可能となっています！ なにをインストールする必要もなく開始1秒で利用できるので、私も重宝してます なお、ページを開くとサンプルAPI仕様がすでにある状態でのスタートとなり、記法の参考などにもなります vscodeで書く 必要なプラグインをインストールし、vsc
LaravelアプリケーションのAPIがSwagger/OpenAPIドキュメントに準拠していることを透過的にテストする｜Laravel｜PHP｜開発ブログ｜株式会社Nextat（ネクスタット）
top > 開発ブログ > PHP > Laravel > LaravelアプリケーションのAPIがSwagger/OpenAPIドキュメントに準拠していることを透過的にテストする こんにちは、でぃーほりです。 Laravelアプリケーション開発において、 「API実装がSwagger/OpenAPIドキュメントに準拠していることを透過的にテストする」 仕組みを構築する機会があったので、背景・モチベーションから順を追ってご紹介します。 対象読者 バックエンドAPI開発に携わっている API仕様の文書化にSwagger/OASを使用している API仕様と実装が乖離して困っている 背景 Swagger/OASとはAPI仕様の文書化標準です。 HTTPリクエスト/レスポンスの形式を、人間とコンピュータの両者が理解できる形で文書化できます。 OAS(OpenAPI Specification)はS
フューチャーのSwagger（OpenAPI 2.0）規約の紹介 | フューチャー技術ブログ
おそらく一般的にSwaggerと呼ばれるのはSwagger 2.0で、これは2014に公開された規約です。Swagger 2.0はOpenAPI 2.0と同義で、OpenAPI 3.0.0には2017年に、3.0.3は2020年に公開されています。 なぜ作ったかフューチャーは常に数十の開発プロジェクトが動いており、それぞれの案件内でちょっとした開発規約が作られることもあれば、暗黙的に遵守されるルールもあります。プロジェクトの大小も様々で数名から数百人規模に及ぶこともあり、新卒採用もキャリア採用も活発なので、フレッシュなメンバーも多くジョインしてくれます。 キャッチアップをしやすいように暗黙知を減らし明文化する意味でも、一定ラインの品質を守るためのガイドラインを作る文化があります（大なり小なりどこでもそうだと思いますが）。個人的にも隣のプロジェクトが同じ技術スタックを採用しているのに、マイナ
Go 1.16のembedとgo-swaggerを組み合わせてフルスタック自動生成フレームワークを作る | フューチャー技術ブログ
TIGの伊藤真彦です。 渋川さんが投稿された Go 1.16のembedとchiとSingle Page Application Go 1.16のgo:embedとNext.jsの相性が悪い問題と戦う に近い研究記事です。 やりたいこと 私の最近の仕事はgo-swaggerによるバックエンドAPI開発です。本流はバックエンドですが、必要に応じてクラウドインフラを弄ったり、ちょっとしたフロントエンドアプリケーションを作ったりといった動き方で働いています。 ある時、go-swaggerで作ったバックエンドAPIの資産を使って、ちょっとした開発者向けアプリケーションを作りたくなりました。 ローカル環境でサーバーとフロントエンドアプリケーションを両方起動すると、サーバーがlocalhost:3000 フロントエンドがlocalhost:8080を占拠してしまいます。また、フロントエンドとバックエン
ファイル分割もいいけど、取り回しわるくなるとねぇ 分割ファイルをひとまとめにするスクリプトをメンテするのさぼっちゃうし 分割そのままで対応してきてるツールももうあるのかな・・？ でもそうするとprismとかのモック動かすときにどうなるんだろう・・ 1ファイルにしといて、コードジャンプやらの開発環境を最強にできればそれがベストなのでは！ ということでvscodeに入れるプラグイン考えていきましょう 入れるプラグイン vscodeでswagger書くっていったらやっぱりこれ swagger ui表示しながら書かないとね 正直これはちゃんと活用できている気がしないけど、改めて調べてみるとめっちゃ便利な機能なんすね・・ Snippetsとか書いてあると脳死でインストールしてしまうのですよ・・ これからは活用していこう もっと快適にかきたい！と思って今回調べて追加したやつ swaggerって1ファイ
注意 まだ書くべきことはたくさんある go-swaggerは駄目だ、と見切りをつけて数年が経つので、情報が古い可能性がある OpenAPI 3.x を否定するものではない（むしろそちらには若干の希望を感じている） 解決策は書いてない 結論 Swagger generates go-server codeを採用するには、相当な覚悟が必要 どうせやるならOpenAPI 3.xに賭けたほうがいい 背景 この記事を書こうと思った動機 とつぶやいたものの、そのデメリットについて明確な言語化したことがなく、 単なる言いがかりじゃない というところをきちんとしておくため。 Swaggerはつらいよ 実際にプロジェクトで採用してみた結果、一体何が辛かったのかについて、3つの点から解説する。 問題点1: Swaggerの表現力と戦わねばならない そもそも$refがキツイ 説明まで含めて完全に同一な定義なんて
GitHub - alufers/mitmproxy2swagger: Automagically reverse-engineer REST APIs via capturing traffic
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
GitHub - contiamo/restful-react: A consistent, declarative way of interacting with RESTful backends, featuring code-generation from Swagger and OpenAPI specs 🔥
⚠️ restful-react has been deprecated: We are focusing on a new open api generator that generates react-query components: https://github.com/fabien0102/openapi-codegen ⚠️ Building React apps that interact with a RESTful API presents a set of questions, challenges and potential gotchas. This project aims to remove such pitfalls, and provide a pleasant developer experience when crafting such applicat
Go のフレームワークに求めるものこの場合、フレームワークに対して何を求めるでしょうか。 私は以下を重要視していました。 重要視したことドキュメントと実装の乖離をなくすことで、認識齟齬なく開発を行うこと なぜ？ ドキュメントと実装のズレを解消するコストが高いため Web API 開発をする中で最も困ることは ドキュメントと実装がかけ離れること です。ドキュメントととのずれによる、コミュニケーションを極力減らしたいと考えました インターフェイスが頻繁に変わることが想定されたため データ定義の部分が固く決まっていなかったため、データに引きずられて API 仕様の変更も頻繁に起きるだろうと思いました インターフェイスのやり取りの物理的な距離が遠いため 同一の会社内だけでなく会社間をまたいだ開発も想定されたため、コミュニケーションコストがより高くなると想定しました フレームワーク比較ドキュメントと
AWS CDK で API Gateway + Swaggerの環境を構築する | DevelopersIO
おはようございます。CX事業本部＠札幌の佐藤です。 はじめに AWS CDKではAPI Gatewayを作成する方法として、以下の3種類の方法があります。 @aws-cdk/aws-apigatewayの RestAPI を使う（基本はこれ） @aws-cdk/aws-apigatewayの CfnXXXX を使う（冗長な記述になる） @aws-cdk/aws-samの CfnApi を使う（AWS SAMのAWS::Serverless::Apiと同じ） 概要 AWS CDKを使ってサーバーレスなRestAPIのインフラを構築することになりました。AWS SAMだと、AWS::Serverless::Apiを使えば、Swaggerに対応しているんですが、AWS CDKでは以下のIssueにある通り、現状API GatewayのSwaggerが対応されていません。（対応予定ではあります）
今回は、swaggerを使って開発効率を爆上げしたいあなたに、ちょっと踏み込んだswagger活用術を紹介したいと思います！ paths sectionを修正しなければいけない機会を最大限少なくする paths sectionってそもそも指定すべきプロパティが多いので、ちゃんとAPI仕様を作ろうと思うとどうしても見づらくなります 特に、parametersやrequestBody、responsesが同居すると記述のルールが違うので統一感がなく、階層が深くなり見づらいです そんなpathsはやはり最大限シンプルに保つべきというのが運用していて思うことです 以下にpathsを最大限シンプルに記述した例を提示しますので、是非参考にしてみてはいかがでしょうか！ openapi: 3.0.3 servers: - url: http://localhost:3000 info: title: te
ASP.NET Core 6.0では2か所変更するだけでSwaggerを使えます - ROBOT PAYMENT TECH-BLOG
こんにちは、決済サービスの開発を担当している近藤です。決済サービスでは多くのプログラムで.NET Framework 4.8を使用して開発をしていますが、.NET 6 での開発も増えているところです。今回は .NET 6でAPIドキュメントを作成する際に使用するSwaggerについて簡単な導入方法をご紹介します。 SwaggerはAPIドキュメントを作成するためのツールセットです。.NET 6 ではNugetパッケージ「Swashbackle.AspNetCore」を取得することで使用できます。これを使うことでREST APIのコードとコメントからAPIドキュメントを作成できるため、ドキュメント作成の手間が省けます。 プロジェクトを新規作成すればそのままSwaggerを使用できるが、説明が出ない 2か所変更してコメントを使用できるようにする プロジェクトを新規作成すればそのままSwagge
Web 開発の現場でよく耳にする言葉として Swagger というものがあります。アプリケーション開発においてサーバー（WebAPI）とデータの送受信を行う機能は不可欠なものとなっている現在、多くの現場ではそのための設計モデルとして REST (REpresentational State Transfer) という方式が使われています。この記事では、REST API の仕様ドキュメントを記述する手段として OpenAPI (Swagger) というものを紹介し、REST Client 機能を備えたインタラクティブな API 仕様ドキュメントを作成・共有する方法についてお伝えしたいと思います。 OpenAPI (Swagger) とは？OpenAPI Specification (OAS) といい、REST API の仕様を記述するためのフォーマットです。また Swagger とは、Ope
Intro SwaggerUI を利用すると、OpenAPIで記述したAPI仕様書をHTTPサーバーとしてインターネットに公開したり、または ローカルにHTTPサーバーとして起動して確認できます。 チームで開発する場合、同じドキュメントを不特定多数のメンバーと共有して開発したくなるユースケースが発生することがあると思います。 SwaggerUI の Docker Image をサーバーとして起動させ配信したりする方法もありますが、何らかの社内の事情で使えない場合や、もう少し簡単に始めたい場合に、HTMLファイルとして出力し、ブラウザで確認するというアプローチもあります。 HTMLに変換してブラウザで確認する OpenAPIで記述したファイルから、洗練されたスタイルが適用されたHTMLファイルにしてブラウザに確認するアプローチとしていくつかあります。 swagger-codegen swag
![[Swagger] OpenAPI3.0で記述したAPI仕様書をHTMLとして出力する - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/6949494f67b979c02b593f2e6b236f72d1b2933d/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-412672c5f0600ab9a64263b751f1bc81.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTk3MiZoPTM3OCZ0eHQ9JTVCU3dhZ2dlciU1RCUyME9wZW5BUEkzLjAlRTMlODElQTclRTglQTglOTglRTglQkYlQjAlRTMlODElOTclRTMlODElOUZBUEklRTQlQkIlOTUlRTYlQTclOTglRTYlOUIlQjglRTMlODIlOTJIVE1MJUUzJTgxJUE4JUUzJTgxJTk3JUUzJTgxJUE2JUU1JTg3JUJBJUU1JThBJTlCJUUzJTgxJTk5JUUzJTgyJThCJnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9NTYmcz0yYWExYjBiMzcyZmI4ZGJmN2Y1Njk2OGRkOTA0MzgyMA%26mark-x%3D142%26mark-y%3D57%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZoPTc2Jnc9NzcwJnR4dD0lNDBnb2RnYXJkZW4mdHh0LWNvbG9yPSUyMzIxMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT0zNiZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZzPWJkNzFlMzYwOGE1NjhkNDAxOWFkNzE0YzBjYWYyYWJl%26blend-x%3D142%26blend-y%3D486%26blend-mode%3Dnormal%26s%3Dd631663138538c5fb5546d4058ce6a77)
Swagger + API Gateway + lambda でAPI定義を流用したAPIサーバー構築 - 虎の穴開発室ブログ
こんにちは、とらのあな通販のマーケティングチームでスクラムマスターを担当している大場です。 本記事は虎の穴ラボ Advent Calendar 2021 - Qiita 6日目の記事です。 5日目はY.I.さんの『Anime.js + SVG で画像をヌルヌル動かす！』でした。 toranoana-lab.hatenablog.com 明日の7日目は服部さんによる『VSCode Remote Container 』に関する記事の投稿を予定しています。 目次 目次 はじめに Swaggerとは Swaggerの記述方法について Swagger + API Gateway + lambda でのサーバ構築 Swagger Viewer インストール 起動 Swagger Spec （サンプル） Lambda 1.Lambda 関数の作成 2.関数の作成 3.テスト実行 API Gateway
OpenAPIとSwagger 入門
OpenAPIとSwaggerの違い What Is the Difference Between Swagger and OpenAPI? OpenAPI: RESTful APIの仕様を記述するためのフォーマット Swagger: OpenAPIを使用するツールのこと Swaggerのツールは、色々ありますが以下の3つがよく使われるようです。 名前 概要
こんにちは。西日本テクノロジー＆イノベーション室の藤田です。 日々（技術的に）強くなりたいと言っている新卒3年目です。 弊社では名刺を入社した時に100枚、それ以降も部門名称が変わるたびに100枚ずつ支給されるのですが、入社してからもらった名刺は400枚になりました。来年には500枚になっているかもしれません。 この記事では、先日まで関わっていたサービス開発案件で蓄積されたノウハウとして、Swaggerで生成したmockサーバーを使ってUI開発をする流れを書いていきます。 背景 3人チームで新規サービスを開発していました。 APIはRuby on Rails、UIはReactを使っており、私はUI開発者として参画しました。 今回の開発では、API開発を待たずともUIの開発ができるよう、Swaggerを使って生成したmockサーバーを使ってUI開発を行いました。 ここではSwaggerを使っ
ASP.NET Coreとフロントエンドの繋ぎこみをOpenAPI(Swagger)定義ファイルを使って効率化する - Qiita
TL;DR 以下の手順で作られるコードを以下に置いておきます。お忙しい方はこちらからどうぞ https://github.com/ishiyama0530/worksample-dotnetcore-swagger-axios モチベーション ソースコードからOpenAPIのインターフェースを生成したい SwaggerUIを表示したい OpenAPIの定義ファイルをJSON/YAML形式で出力したい 定義ファイルからAxiosのコードを生成したい すべてを1コマンドで行いたい 参考 Swashbuckle と ASP.NET Core の概要 プロジェクト構成 最終的にはこんな感じになります。 $ tree ./worksample-dotnetcore-swagger-axios -a -L 1 ./worksample-dotnetcore-swagger-axios ├── .con
OpenAPI(Swagger)を利用してTypeScriptのAPI Clientを自動生成する設計と実装 | himenon.github.io
追記 (2021/11/01)手前味噌ではありますが、自作したTypeScript Code Generatorの記事も参照してみてください。 OpenAPIのenumがUnionTypeで吐き出されないなど、細かい問題を解決しています。 OpenAPI TypeScript Code GeneratorをASTを利用して作成しましたOpenAPI Specification(OAS)とはなにかOpenAPI SpecificationはAPIを記述するため規格で、旧名がSwaggerとなっている。HTTP APIをインターフェースとするSchema定義になっているため、相手がWEBでなくても良い。→ すなわち、WEB APIではなくてシステム間のプロトコルベースがHTTPであればOpenAPI Schemaで記述可能となる。Schemaの例) Develop with Docker
GitHub - anymaniax/orval: orval is able to generate client with appropriate type-signatures (TypeScript) from any valid OpenAPI v3 or Swagger v2 specification, either in yaml or json formats. 🍺
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
この記事は STORES.jp Advent Calendar 2019 の2日目です。 私が勤めているストアーズ・ドット・ジェーピー株式会社（以下STORES.jp）はheyグループとなり急拡大している真っ最中で、それはエンジニアチームも例外ではありません。 2018年ごろまでは10人に満たないエンジニアチームで開発を行なっていたSTORES.jpでしたがここ1年くらいで30人以上のエンジニアが関わるようになりました。 まだまだやりたいことはたくさんあるので、これからもっとエンジニアチームを拡大していくことを計画しています。 そして、急拡大する中で今まで感じなかった課題が多数発生するようになりました。 その中のひとつが「APIを介したフロントエンドとバックエンドの協働が難しい」というものです。 STORES.jp開発チームで起きていた課題STORES.jpは2018年ごろまでは少数精鋭の
Rails プロジェクトで クライアント向けの APIClient を自動生成するときの構成を試してみた． Swagger で記述した API 定義からコード生成する例はちらほら見かけるが，Netflix 製の fast_jsonapi を使った記事は見かけなかったので，まとめておく． 完成版のソースコードはこちら 👉 tanakaworld/swagger-blocks-fastjson-api TL;DR;# Part1: API定義編 (本記事) Backend は Rails で API を実装 JSON シリアライザとして，Netflix 製の fastjson_api API 定義は swagger-blocks を使用 Part2: コード生成編 (作成中) openapi-generator で TypeScript の APIClient を自動生成 Part3: 自動
Bearer トークンを使用して WebAPI 呼び出しをする場合、OpenAPI (Swagger) 3.0 ではどのように記述するのでしょうか。 OpenAPI (Swagger) で WebAPI の仕様を記述する際、HTTP 認証・認可を行うための手段として Basic 認証・Bearer スキーム・API キー等の使用を定義することができます。この記事ではアクセストークン等による Bearer スキームの記述方法について紹介します。 ※ OpenAPI (Swagger) については以下の記事で取り上げていますので、合わせてご確認ください。 Bearer スキームとはHTTP 認証スキームの一つで、WebAPI へアクセスするためのセキュリティトークン（アクセストークン等）をAuthorization: Bearer {トークン}という形で HTTP ヘッダーにセットし、トークン
はじめにDart/Flutter連載の2記事目です。 はじめまして、TIGの宮崎将太です。 突然ですがみなさん、Swagger使いたいですよね。当社でもGo言語などでSwaggerを用いてREST APIサーバ/クライアントコードを生成する機会が増えています。 たまたま Flutter+Rails でアプリケーション構築をする機会があったので、今回Flutterのみに着目してSwagger(OpenAPISpec)を使用する方法をコード付きで解説していきます。(Railsは需要があったら書こうと思いますので、SNSでリアクションもらえるとです！) Swaggerとは？Swagger(OpenAPISpec)とはREST API仕様をyamlやjsonベースで定義できるフォーマットを定めたツールで、定義書を書くとAPI仕様書やサーバ、クライアントコードを生成できちゃう優れものです。 2系、3
GitHub - acacode/swagger-typescript-api: TypeScript API generator via Swagger scheme
Generate api via swagger scheme. Supports OA 3.0, 2.0, JSON, yaml Generated api module use Fetch Api or Axios to make requests. Any questions you can ask here or in our slack(#swagger-typescript-api channel) P.S. If you are creating the PR, please check your changes with using command npm run prepare P.S. If you want to contribute please use the next branch. All PRs that has target master will be
概要 Visual Studio Code で普段利用している拡張機能ご紹介です。 今回はSwagger Viewerです。 Visual Studio Code上でSwagger Editorを使用できる機能です。 marketplace.visualstudio.com 起動の方法 エクスプローラーのコンテキストメニューから起動できます。 コマンドパレットからも起動できます。 起動後 基本的にはSwagger Editorと同様です。 対象のyamlを編集するとリアルタイムで反映されます。 注意点 Swagger Viewerを使用する場合、 localhost:9000 を使用するようです。ポート番号がかぶる場合は他のもののポートを変えるか、拡張機能を一時的に無効にすることが必要です。 あとがき Swagger YAML を Visual Studio Code で編集できるので便利
The Gopher character is based on the Go mascot designed by Renée French. TIG DXチームの伊藤真彦です。 今回はgo-swaggerの具体的な実装方法を紹介します。 目次 はじめに go-swaggerのインストール swagger.yamlを準備する ソースコードをビルドする 試しにサーバーを立ち上げてみる ハンドラを実装する ついにhello world完了 はじめに最近の私のメイン業務はgo-swaggerを用いたAPI開発です。 go-swaggerはOpenAPI(Swagger) からGoのコードを生成するライブラリです。 フューチャーでは複数案件での採用実績があり、この技術ブログでも様々な記事が書かれています。 しかし、技術選定としての参考情報やtips集はあるものの、どのように実装していけばAPIが
この記事は スターフェスティバル スターフェスティバル Advent Calendar 2022の14日目の記事です。 スターフェスティバル株式会社 ソフトウェアエンジニアのishidaです。 先日チーム内で「Clean Craftsmanship 規律、基準、倫理」という書籍のサマリー共有会があり、テストの重要性の認識が深まっている今日この頃です。 APIのテストをCIで回せたらいいなって思ったので、Swagger定義からテストを生成してGitHub Actionsで実行してみようと思います。 方針 弊社ではOpenAPI(Swagger)を用いて開発をしていますので、 前述の通りSwagger定義からテストを生成してCIで実行したい気持ちがあります。 そのため Swagger(OpenAPI3)に対応していること CIで実行しやすい(手軽にコマンドラインで実行できる) の条件のpack
package main import ( "github.com/gin-gonic/gin" swaggerFiles "github.com/swaggo/files" "github.com/swaggo/gin-swagger" "net/http" _ "use_swagger/docs" ) // @title APIドキュメントのタイトル // @version バージョン(1.0) // @description 仕様書に関する内容説明 // @termsOfService 仕様書使用する際の注意事項 // @contact.name APIサポーター // @contact.url http://www.swagger.io/support // @contact.email support@swagger.io // @license.name ライセンス(必須) /
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Wordな職場にSwaggerを定着させようとして失敗したけど結局定着した話 - Qiita
swagger-merger を用いた大規模API開発における Swagger 運用
OpenAPI (Swagger) まとめ - Qiita
現場で必要になるswaggerの知識 - Qiita
Swaggerを使ったAPIドキュメントの作成と、バックエンドとフロントエンド間の連携
今日から始めるswagger入門（最低限書けるようになる） - Qiita
Swagger UI
もっと快適にvscodeでswaggerを書きたい！（プラグインまとめ） - Qiita
Swagger (OpenAPI 2.x) generates go-server codeの何が辛いのか
WAFとして go-swagger を選択してみた | フューチャー技術ブログ
開発効率を爆上げするswagger術 - Qiita
OpenAPI (Swagger) を利用して効率よく WebAPI の仕様を管理する
[Swagger] OpenAPI3.0で記述したAPI仕様書をHTMLとして出力する - Qiita
UI開発にSwaggerで作ったmockサーバーを使う | Fintan
OpenAPI(Swagger)がYAMLを書かなくてよくなっていたのでSTORES.jpでも導入しました｜morihirok｜note
Rails で swagger-blocks と fastjson_api を組み合わせる (API定義編)
OpenAPI (Swagger) 3.0 で Bearer トークンの使用を定義する
Flutter Swagger統合 | フューチャー技術ブログ
【VSCode】おすすめ拡張機能 - Swagger Viewer - 開発覚書はてな版
go-swaggerでhello world | フューチャー技術ブログ
Swagger定義から生成したAPIのテストをCIで実行する
GO/Gin gin-swagger使用してAPI仕様書を生成します - Qiita