QuarkusでSwagger UIを見るには拡張機能としてSmallRye OpenAPIを追加します。 Swagger UIへのアクセスはホスト名にswagger-uiを追加するとアクセスできるようになります。 拡張機能を追加する方法は以下の3つあります。 https://code.quarkus.io/で作成時に追加 maven で作成時に追加 既存のQuarkusプロジェクトに追加 今回は既存のQuarkusプロジェクトに追加する方法を紹介します。既存のQuarkusプロジェクトに新たな拡張機能を追加するにはquarkus:add-extensionを使い、-Dextensionsで追加したい拡張機能を指定します。 今回拡張したい追加機能はio.quarkus:quarkus-smallrye-openapiなので、以下のようになります。 mvn quarkus:add-exten
レッドハットでコンサルティングしているフェンです。 今回は、swagger-uiをFuseアプリケーションに埋め込み、APIドキュメント(WebAPI仕様書)を簡単に公開するサンプルと設定内容を紹介します。 このサンプルでは、Swagger UI を使用して、RES DSL で定義されたAPIのAPIドキュメント(WebAPI仕様書)を表示します。 ソースコードはGithub（https://github.com/jian-feng/camel-restdsl-swagger-demo.git）からダウンロードできます。 サンプルアプリの構造 Swagger UIとCamel REST DSL Swagger とは、RESTful APIのドキュメントや、サーバ、クライアントコード、エディタ、またそれらを扱うための仕様などを提供するフレームワークであります。 Swagger UI とは、S
Gradle Swagger Generator PluginでSwagger UIを生成できるようになりました。 以下のビルドスクリプトで generateSwaggerUI タスクを実行すると、 build/swagger-ui フォルダにSwagger UIが出力されます。 plugins { id 'org.hidetake.swagger.generator' version '1.5.1' } repositories { jcenter() } dependencies { swaggerUI 'org.webjars:swagger-ui:2.2.6' } generateSwaggerUI { inputFile = file('petstore.yaml') } 利用シーン swagger2markupのHTMLドキュメントだけでは読みづらいので、Swagger UIを
Swaggerのソースコード生成をGradleで利用するためのプラグインを書きました。 github.com 以下のようなビルドスクリプトを実行すると、SwaggerでAPIサーバを自動生成できます。 plugins { id 'org.hidetake.swagger.codegen' version '1.0.0' } repositories { jcenter() } dependencies { // declare swaggerCodegen to run CLI swaggerCodegen 'io.swagger:swagger-codegen-cli:2.2.1' } // declare a task to generate code task generateServer(type: SwaggerCodegen) { language = 'spring' inp
こんなに簡単! Swagger Codegenのカスタマイズ waculでフロントエンジニアをしている @Quramy です。 今日はswaggerの話をしようと思います。 はじめに waculでは、API定義にはJSON Hyper Schemaを用いており、swaggerは現在利用していません。しかし、先月のOpen API Initiative発足等、にわかに盛りあがり始めたのを見て「swaggerも触ってみようか」と思い始めている状況です。 現状のサービス開発フローにおいても prmdを使ってJSON Hyper SchemaでAPI仕様を作成 1.の出力からサーバ側(golang)とフロント(TypeSciprt)用のコードを作成 2.をプログラムから利用 という流れを踏んでおり, 特に2.の部分は自作のライブラリで実現しています（この辺りの事情や実装は僕よりも @tutumin
15. Swagger What is Swagger? The goal of Swagger™ is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via Swagger, a consumer can understand and interact with the remote service with a
You can find (just about) anything on Medium — apparently even a page that doesn’t exist. Maybe these stories will take you somewhere new?
Sometime it is handy to have sample request or response example. Working with integration of larger project SUPERHUB, we go from API design over samples, validating them and finally implementing. Samples are key component in communication about API. Option "tree": agreed tree structure with basePathExamples parameter API declaration would get new attribute "basePathExamples". Default value for bas
渋谷java行ってきました。Spring Boot と Swagger というタイトルでLTさせていただきました。内容はSwaggerをSpringから便利に使えるSpringFoxのお話です。 http://swagger.io/ http://springfox.github.io/springfox/ speakerdeck.com WebAPIのドキュメント作成のコストはできるだけ下げたいところです。apiaryというサービスもすごく良さそうなのですが、Swaggerを使うことにしました。今のところ大きな不満はないです、自分でドキュメント書くよりは全然良いですね。 ビズリーチさんの会場は波の音が絶えず聞こえてて、すごく居心地がよかったです。ありがとうございました！
neuecc/LightNode · GitHub が新しい Swagger UI に対応したっていうのを見かけたので、こっちも見直してみようかなと。 *1 Swagger 拡張のメモ - お だ のスペースからの変わった点のメモ。 Swagger のバージョンを 1.5.2-M1 から 1.5.0 にしました。*2 大きな変更点は、パッケージが変わりました。合わせて Maven Repository の GroupId も変わっているので注意！ com.wordnik から io.swagger になっています。 @DefaultValue に対応しています。 io.swagger.jaxrs.ParameterProcessor クラスが追加され、そこで Parameter に付与されているアノテーションに対し色々処理するようになっています。 ParameterProcessor#ap
個人的なメモ。 Swagger 2.0 についての説明は本家や適当に調べて下さい。 REST APIを記述せよ！Swagger紹介 #apijp - Groovyラボ Swagger の紹介されているサイトでは、WebAPI と Swagger UI を同居させるパターンが多くて、public なサービスだと良いのかもですが、開発中だけ Swagger UI 欲しい場合はちょい不便。 というわけで、ビルド時に Swagger JSON を吐く時のメモです。 Swagger は v1 の時は Scala で書かれていて読むのしんどかった*1けど、v2 からは、Java で書き直されていて大分楽でした。 v2 といってるけど、jar 的には 1.5.2-M1 です。 今回は JAX-RS で使うのでそっちメインで追ってます。 .NET での利用(ASP.NET WebAPI や Azure A
ども、大瀧です。 Amazon API Gateway、皆さん触ってますか?APIサーバーに関する様々な機能があって便利ですが、Management ConsoleでのAPI定義や設定が煩わしいと感じる方もいると思います。そこで今回は、Amazon API Gateway Swagger Importerを利用してAPI定義を一括でやってみたいと思います。 セットアップ 動作確認環境 OS : Mac OS X Yosemite AWS CLI : 1.7.39 Mavenを利用するために、HomebrewでJavaと一緒にインストールしておきます。 $ brew install Caskroom/cask/java $ brew install maven 続いて、GitHubリポジトリをCloneし、README.mdに従いMavenを実行します。 $ git clone https:
この記事は、微妙に以下の記事の延長線上です。わかりにくければ、こちらから読んでいただいた方がいいかもしれません。 LittleBitsを使ったIoTをつくり、家の室温変化のグラフをインターネットから見る（前編） - Qiita 「インタラクティブなWeb APIドキュメント」とはどういうものか Swaggerというツールを使います。Web APIをYAMLで書いておいて、Swaggerでサーバを立てると、読むだけのドキュメントではなくて、以下のようにパラメータを指定して実際にHTTPリクエストを送ることができるWebページが生成されます。 以下が返ってきたレスポンスです。 以下は実物です。ご自由に動かしてみて下さい。 インタラクティブなWeb APIドキュメント まだちょっと分かりにくいという方のために、アノテーションからドキュメントを作れるswaggerの使い方 - gong023の日記
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
