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

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

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

OpenAPI Generatorに適したOpenAPIの書き方 - ZOZO TECH BLOG

2023/03/15 23 users OpenApi WEAR API クライアント 自動生成

はじめに こんにちは！　WEARバックエンドブロックの高久です。 WEARではOpenAPI（Swagger）を使って、アプリやWebのクライアントが利用するAPIを定義しています。そして先日、開発効率化のためにOpenAPI GeneratorでOpenAPIからAPIクライアントコードを自動生成、活用できるように整備をしました。その中でOpenAPI Gene... 続きを読む

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で作ってそっちは前例がほぼないので... 続きを読む

【小ネタ】AWS CDKでAPI Gateway + Swaggerの環境を構築する ｜ Developers.IO

2019/11/06 12 users RestApi aws-cdk AWS CDK AWS 冗長

おはようございます。CX事業本部＠札幌の佐藤です。 はじめに AWS CDKではAPI Gatewayを作成する方法として、以下の3種類の方法があります。 @aws-cdk/aws-apigatewayの RestAPI を使う（基本はこれ） @aws-cdk/aws-apigatewayの CfnXXXX を使う（冗長な記述になる） @aws-cdk/aws-samの CfnApi を使う（AWS SAMのAWS::S... 続きを読む

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つ... 続きを読む

OpenAPIのschema定義からRubyのクラスを生成するgem「openapi2ruby」をつくりました - Start Today Technologies TECH BLOG

2018/06/28 49 users OpenApi gem レスポンス Ruby API

こんにちは。スタートトゥデイテクノロジーズ新事業創造部のid:takanamitoです。 今日はVASILY時代から活用されているOpenAPI(Swagger)の定義からRubyのクラスを自動生成するgemを作ったので、その紹介をしようと思います。 Swaggerの定義と実際のAPIが返すレスポンスの内容がズレている 弊社ではVASILY時代からSwagger... 続きを読む

まだ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とAPIのデザイン

2017/12/14 15 users interest Twitter WebVR company

SwaggerとAPIのデザイン 1. SwaggerとAPIのデザイン Swaggerではじめる楽々RESTful APIデザイン&ドキュメント管理 2017/5/12 Okachi.js vol.5 第1回 2. 出演 {:company “Greative.GK” :name “Kazuhiro Hara” :twitter “@kara_d” :interest “SPA, WebVR, ... 続きを読む

Swaggerで定義したAPI仕様から Retrofitで使用するinterfaceを自動生成してみる // Speaker Deck

2017/11/28 30 users INTERFACE Retrofit API仕様 自動生成

- swagger-api/swagger-parser https://github.com/swagger-api/swagger-parser - square/kotlinpoet https://github.com/square/kotlinpoet - HOW TO CREATE A GRADLE PLUGIN IN KOTLIN https://www.thedroidsonroi... 続きを読む

開発効率を上げる！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をAWS Serverless Application Modelから扱う方法を理解する ｜ Developers.IO

2017/03/08 15 users API APIGateway serverless AWS

はじめに こんにちは、中山です。 最近 Swagger をAWS Serverless Application Model(以下AWS SAM)から利用する機会がありました。AWS SAMでは AWS::Serverless::Api または AWS::ApiGateway::RestApi リソースを利用することにより、Swagger形式で記述されたファイルを扱うことが可能です。基本的にAWS ... 続きを読む

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

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

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

クラスメソッドさんの勉強会で、Swaggerの話をしてきました - プログラマになりたい

2015/11/23 26 users AWS プログラマ AWSモバイル クラスメソッドさん テーマ

2015-11-24 クラスメソッドさんの勉強会で、Swaggerの話をしてきました aws 縁あってクラスメソッドさん＆Amazon Web Servicies Japan主催の「AWSモバイル/IoTサービス徹底攻略！！」に登壇してきました。テーマは、"Swaggerで始めるモデルファーストなAPI開発"ということで、Swaggerの話です。 発表の内容 ベーシックセッションで、またそもそもS... 続きを読む

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... 続きを読む

「SWAGGER」の企画販売会社、自己破産申請へ （帝国データバンク） - Yahoo!ニュース

2013/02/04 16 users アリソン Yahoo 帝国データバンク 自己破産申請 ニュース

（有）スワッガー（TDB企業コード：981183123、資本金300万円、東京都渋谷区神宮前4-28-22、代表井口秀浩氏）と（株）アリソン（TDB企業コード：902002484、資本金900万円、東京都渋谷区猿楽町9-8、代表荒川雄太郎氏）は、2月1日までに事後処理を浅見隆行弁護士（東京都千代田区内神田2-11-6、電話03-3254-1071）に一任した。現在、自己破産申請の準備中。 （有）ス... 続きを読む

RESTfulなWeb APIを実際に実行して結果を確認できるWebサービス「Swagger」 - MOONGIFT|オープンソース・ソフトウェア紹介を軸としたITエンジニア、Webデザイナー向けブログ

2011/09/09 37 users Twitter Facebook MOONGIFT フィード

SwaggerはScala製のオープンソース・ソフトウェア。Web APIが十分に普及してきたことで、何気なくWeb APIを利用できるようになってきた。TwitterやFacebookはその最たるものだが、小さなものとしてはフィードを取り込むようなものも数多く使われている。 0 Web API一覧 Web APIでは提供形式としてRESTfulなものが最も多くなっている。RESTfulなWeb ... 続きを読む

WebAPIを綺麗にスタイルしてデモ付きでドキュメント化できる「Swagger」:phpspot開発日誌

2011/09/06 42 users Twitter Facebook WebAPI API 成功

Swagger: A simple, open standard for describing REST APIs with JSON WebAPIを綺麗にスタイルしてデモ付きでドキュメント化できる「Swagger」 TwitterやFacebook等、大きいサイトはAPIを提供して利用者が自由にアプリケーションを作成して便利に使えますね。 成功の理由にはAPIも大きく寄与していそうです。 そこで... 続きを読む