Wordな職場にSwaggerを定着させようとして失敗したけど結局定着した話 - Qiita
はじめに 私の職場では、WebAPIの仕様書をWordで書く習慣があったのですが、2018年頃にSwaggerで書くように切り替わったので、そのように変化した経緯を書きます。 何かの参考になれば幸いです。 ちなみに、こちらの記事と同じ職場です。 Wordな職場にMarkdownを定着させるためにやった４つのこと Swaggerとは？ Swaggerとは、REST APIの仕様を定義するためのフォーマットです。その周辺技術も含めて、Swaggerと呼ばれます。以下の記事が非常に参考になりますので、詳細を知りたい方はご参照ください。 Swaggerの概要をまとめてみた。 Swagger 導入失敗 2016年頃のある日、上司から「世の中にはSwaggerというものがあるらしい。調べてもらえる？」と指示されました。 調べてみたところ、Swaggerがあれば、WebAPIのドキュメントサイトも作れる
平静を保ち、コードを生成せよ 〜 OpenAPI Generator誕生の背景と軌跡 〜 / gunmaweb34
Gunma.web #34 スキーマ駆動開発で発表した資料です！ https://gunmaweb.connpass.com/event/113974/ (追記) OpenAPI Generatorの電子書籍をリリースしましたのでぜひチェックしてください！ REST API のためのコード生成入門 (OpenAPI Generator) https://gumroad.com/l/openapi_generator_ebook_jp (/追記) 発表時から下記修正を加えました。 * サブタイトルをつけ忘れていたのを修正しました * 一部の画面キャプチャを非表示にしました (非表示にした理由はスライドに記載しています)
Spring Boot RESTful API Documentation with Swagger 2 - Spring Framework Guru
The Spring Boot makes developing RESTful services ridiculously easy, and using Swagger makes documenting your RESTful services much easier. Building a back-end API layer introduces a whole new area of challenges that goes beyond implementing just endpoints. You now have clients which will now be using your API. Your clients will need to know how to interact with your API. In SOAP based web service
Getting Started with OpenAPI Tools | Swagger Open Source
What is Swagger? If you’ve ever worked with APIs, chances are, you’ve heard of Swagger. Swagger is the most widely used tooling ecosystem for developing APIs with the OpenAPI Specification (OAS). Swagger consists of both open source as well as professional tools, catering to almost every need and use case. A Brief History Lesson Swagger used to consist of the specification and a large ecosystem of
OpenAPIによるスキーマファースト開発の実施サンプルとCloud Runについて - OPTiM TECH BLOG
こんにちは、インダストリー事業本部 医療チームの高橋（@yukey1031）です。 去年のクリスマス以来の投稿です。AMIAS（アミアス）をお願いします。 さて、今回は自身の周辺業務で普段行っているOpenAPIによるスキーマファースト開発の実施サンプルと先日Google Cloudより発表された「Cloud Run」について少し触れてみたいと思います。 なお、フロントエンドはVue.js+TypeScript+Axios、バックエンドはJava+SpringBootでの話です。 マイクロサービスな現場でのAPI開発 スキーマファースト開発 OpenAPI OpenAPI Generator Cloud Run 実施サンプル Requirement インターフェイス定義 サーバーサイド実装 フロントエンド実装 Cloud Runにデプロイ／接続 おわりに マイクロサービスな現場でのAPI開
Swaggerを利用した新規サービス開発
1. © Recochoku Co.,Ltd. Proprietary and Confidential 2017/02/07 Swaggerを利用した 新規サービス開発 株式会社レコチョク 事業システム推進部 ミュージックアーキテクトグループ 松木 佑徒 2. © Recochoku Co.,Ltd. Proprietary and Confidential 2017/02/07 自己紹介 2 職業：フルスタックエンジニア(自称) 言語：C# (2008~2010) -> Java (2011~2015) -> Python (2016~) 趣味：ドラム / ジャグリング Yuto Matsuki @yustam_jp id:yustam 2008: 某SIerにてシステムエンジニアとして色々な現場で仕事をする 2014: 株式会社レコチョクに転職 2014-2015: レコチョクの楽曲DB
Swagger 定義から goa の design を生成する ago という CLI を作りはじめた - tchsskのブログ
これは Go (その2) Advent Calendar 2016 の 17 日目の記事です。 ここ半年ほど goa というフレームワークを気に入って使っているのですが、思うところがあって goa に関連する ago という CLI を作りはじめました。この記事では、簡単な goa の説明から、今回の開発に至った経緯と、このツールで行えることについて記述します。 goa とは Go でマイクロサービスな Web API を作るためのフレームワークです。 github.com goa の DSL で design と呼ばれる定義を書いたら、 goagen というジェネレータを使ってサーバやクライアントなど各種のコードを生成することができます。毎度リンクを貼らせて頂いているのですが @ikawaha さんによる連載記事が本当にオススメです。 ikawaha.hateblo.jp goa 流行ら
これからMicroservicesな開発をするならgoaがおすすめという話 - Qiita
実際にMicroservicesを作る場合の話 必要な要件を並べてみましたが、自分のチームの場合、実際は上記の多くはApplication側で解決せずAWSやGCP、その他SaaS, PaaSの提供する機能で解決するようにしており、例えば下記のように対処可能です。 Load balancingはAWS ALB Message QueueはAWS SQS TracingはAWS Xray などなど。 とすると、Microservicesを開発する上で大切になってくるのは、チームが多くのAPIとやり取りするその過程を円滑にすることだと考えており、過去はそこをswaggerで記述してAPIデザインをレビューし合うことで解決しておりました。 ただし、課題としてAPIドキュメントを作成するフローと実際にAPIを作るフローが一連の流れにならない、ツールとして別々な世界の話になっているため、ドキュメント
go-swaggerを使う — そこはかとなく書くよん。 ドキュメント
go-swaggerを使う¶ この記事は Go (その2) Advent Calendar 2016 の7日目の記事です。 APIからのコード自動生成ツールとして、swaggerが最近流行ってます(異論は認めます)。 この分野では、 goa が有名ですが、goaはあくまでGoのDSLから生成するという方式です。 swagger定義がすでにある場合には使えません。 swagger定義ありきの場合、今回説明する go-swagger を使うと便利です。 なお、この内容は https://github.com/shirou/swagger_sample にて公開しています。 go-swaggerとは¶ go-swaggerは、swagger定義からgoのサーバーおよびクライアントを生成してくれるツールです。 インストールはgo getでインストールしてもよいのですが、goの環境がない場合は do
API Documentation & Design Tools for Teams | Swagger
NEWAPI Documentation Portal API Development for Everyone Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset. Find out how Swagger can help you design and document your APIs at scale. Explore Swagger Tools SmartBear Named a Visionary by Gartner® in the 2023 Magic Quadrant™ for API Management Learn More
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
DS.API リファレンス
GitHub - Yelp/swagger-gradle-codegen: 💫 A Gradle Plugin to generate your networking code from Swagger
GitHub - int128/gradle-swagger-generator-plugin: Gradle plugin for OpenAPI YAML validation, code generation and API document publishing
GitHub - swagger-api/swagger-codegen: swagger-codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing your OpenAPI / Swagger definition.
Swaggerでのapi開発よもやま話