現場で必要になるswaggerの知識 - Qiita

2023/09/21 115 users Qiita 筆者 最低限 前回 現場

前回は「今日から始めるswagger入門」という最低限書けるようになっておいた方が良い物をこちらの記事で解説させてもらいました 今回は、筆者が4〜5年ほど現場で見てきたswaggerを元に、現場で必要になるswaggerの知識をまとめましたので、ぜひご覧になっていただけると嬉しいです！ タグ付け pathsに書かれている各APIe... 続きを読む

OpenAPI (Swagger) まとめ - Qiita

2022/11/09 71 users OpenApi NEST Rails API node.js

はじめに 自分は実務でReact×TypeScriptを利用したフロント周りとNode.js(Nest)やRailsを用いたバックエンド(API)の開発をしています。 本記事では、OpenAPIを用いたAPI設計の書き方及び、Swaggerの説明と使い方についてまとめていきます。 この記事の対象者 プログラミング初心者から中級者 APIの基礎を理解している人 ... 続きを読む

swagger-merger を用いた大規模API開発における Swagger 運用 | by Toshiaki Takahashi | Finatext | Mar, 2021 | Medium

2021/03/11 51 users toshipon Fin-JAWS mar Finatext

はじめにこんにちは、Finatext で保険事業のプロダクト開発をしている @toshipon です。今回は以前の Fin-JAWS のイベントで少し紹介させていただいた、我々の現場で取り組んでいる、大規模API開発における Swagger を用いたAPI仕様のドキュメント運用方法について紹介いたします。 概要我々の現場では、API ベースのWeb... 続きを読む

Go(Echo), Gorm, Mysql, Docker, Swaggerで、クリーンアーキテクチャなAPIサーバーを作ったメモ

2021/02/19 197 users rust MySQL スクラップ 前例 Python

自分の本業は10年物のMVCプロジェクトなのでClean Architecture忘れがちです。 なので、慣れてるGoでパッとClean Architectureの復習を行ってみました（２年前にPythonでやった事はあるんだけど・・・）。 このスクラップでは単語とか作りどころとかを整理するのですが、また後でRustで作ってそっちは前例がほぼないので... 続きを読む

Wordな職場にSwaggerを定着させようとして失敗したけど結局定着した話 - Qiita

2019/10/29 394 users Markdown WebAPI Qiita word 経緯

はじめに 私の職場では、WebAPIの仕様書をWordで書く習慣があったのですが、2018年頃にSwaggerで書くように切り替わったので、そのように変化した経緯を書きます。 何かの参考になれば幸いです。 ちなみに、こちらの記事と同じ職場です。 Wordな職場にMarkdownを定着させるためにやった４つのこと Swaggerとは？ Swagger... 続きを読む

本当に使ってよかったOpenAPI (Swagger) ツール | Future Tech Blog - フューチャーアーキテクト

2019/10/08 483 users OpenApi フューチャーアーキテクト 冒頭 https

サードパーティ製のツール本家からは上述のツールが提供されていますが、サードバーティ製の様々なツールが世の中には存在します。 エコシステムが成熟しているのもSwaggerを利用するメリットの一つですね。 https://openapi.tools/ 冒頭のとおり、このサードパーティ製のツールの中で実際に利用して良かったツールを3つ... 続きを読む

まだAPI定義管理で消耗してるの？〜Swaggerを用いた大規模アプリ時代のAPI定義管理とコードジェネレート〜 // Speaker Deck

2018/02/08 471 users Speaker Deck

まだAPI定義管理で消耗してるの？〜Swaggerを用いた大規模アプリ時代のAPI定義管理とコードジェネレート〜 続きを読む

Swagger x Heroku で手軽に API モック＆ドキュメントを作る - Qiita

2018/02/06 77 users Heroku Qiita モツ API ドキュメント

概要 Web、モバイル問わず、アプリケーション開発する際には、フロントエンドとバックエンド開発が一斉にスタートすることが多く、フロントエンド開発はバックエンド開発待ちになるケースがよくあります。この待ちの時に、フロントエンド側で仮で叩ける環境があると、予め API の仮テストができ、開発が進みやすくなります。 この記事では Swagger と Heroku を用いて、 API のドキュメントとモッ... 続きを読む

もう管理画面のフロントコードを書く必要はありません、そう Viron ならね。 - Qiita

2018/02/01 632 users Qiita Viron OpenApi jsonファイル 大小

管理画面のフロントエンドコードを書く時代は終わりました。 Viron があれば、OpenApi(Swagger)でAPI定義を行い、実装するだけで管理画面が完成します。 概要 Viron は、複数の管理画面を管理できるよう設計された、管理ツールマネージメントコンソールです。 APIサーバーとOAS2.0 jsonファイルを作成するだけで、管理画面が一つ完成します。 経緯 私の会社では、大小さまざま... 続きを読む

開発効率を上げる！Swaggerで作るWEB APIモック - VASILY DEVELOPERS BLOG

2017/05/19 109 users モック ショー VASILY DEVELOPERS API

2017 - 05 - 19 開発効率を上げる！Swaggerで作るWEB APIモック API Swagger モック こんにちは。バックエンドエンジニアのじょーです。 みなさんは、開発初期の段階でWeb API（以下API）の実装が追いつかずクライアント側が開発できないという経験をしたことはありますか？ クライアント側はAPIがないと開発が滞ってしまうことがありますが、かといってAPIの開発も... 続きを読む

Swaggerとは何か？ - プログラマになりたい

2015/12/02 150 users ドキュメン プログラマ Microsoft 単語 一躍注目

2015-12-02 Swaggerとは何か？ 最近、Swaggerという単語を聞く機会が増えていませんか？MicrosoftやGoogle,IBMが、REST APIの記述標準化を目指した「Open API Initiative」という団体を立ち上げ、そのベースをSwaggerを利用するということで一躍注目を集めるようになりました。しかし、Swaggerというものを調べるとツールの話やドキュメン... 続きを読む

Swaggerで始めるモデルファーストなAPI開発

2015/11/21 259 users Twitter meetup IoT AWS 佐々木拓郎

Swaggerで始めるモデルファーストなAPI開発 1. Swaggerで始める モデルファーストなAPI開発 NRIネットコム株式会社  佐々木拓郎 2015/11/21Developers.IO Meetup 番外編 ∼AWS モバイル/IoT サービス徹底攻略∼ 2. 佐々木拓郎 AWSとモバイルで 飯食ってます blog: http://blog.takuros.net twitter: ... 続きを読む

RESTful APIの記述標準化を目指す「Open API Initiative」をマイクロソフト、Google、IBMらが立ち上げ。Swaggerをベースに － Publickey

2015/11/08 476 users Publickey WSDL データフォーマット IBMら

RESTful APIの記述標準化を目指す「Open API Initiative」をマイクロソフト、Google、IBMらが立ち上げ。Swaggerをベースに 10年以上前、XMLの登場に続いてXMLベースのAPIを記述する標準フォーマット「WSDL」が提唱されました。 WSDLにはAPIの仕様がマシンリーダブルな形で記述されており、APIを呼び出すためのプロトコルやデータフォーマットをあらかじ... 続きを読む

Apiary - r7kamura per second

2014/02/13 88 users autodoc RAML Apiary API ドキュメント

API(とそれに携わる開発者)の規模が拡大してくると、ドキュメントの整備や、仕様と実装の一貫性の維持、 クライアントとの知識の共有など、考慮すべき問題が沢山出てくる。 これらの問題に対する現実的な解決策を探るため、 ApiaryというAPI開発支援用のサービスを簡単に俯瞰することにした。 ここでは紹介しないが、他に RAML、 JSON Schema、 Swagger、 WADL、 Autodoc... 続きを読む