スプリングブートでswaggeruiの使用方法の詳細な説明

sw歩

Swaggerは、サービスインターフェイスを定義するために使用される言語に依存しない仕様とフレームワークであり、主にRestful APIを記述するために使用されます。 APIの優れたドキュメントとクライアントライブラリの作成に焦点を当てています。 Swagger対応のAPIは、APIメソッドのインタラクティブドキュメントを生成し、ユーザーが視覚的に実験し、リクエストと応答、ヘッダーファイル、返信コードを表示することでAPIの機能を発見できるようにします。

Swaggerは、APIドキュメントを定義するために使用されます。

利点：

1. フロントエンドとバックエンドの個別の配達
2. APIドキュメントは非常に明確です
3. テスト中に、ブラウザにURL入力を使用してコントローラーにアクセスする必要がなくなりました
4. URLを入力する従来の方法は、POSTリクエストでパラメーターを渡すのが面倒です（もちろん、Postmanのようなブラウザプラグインを使用できます）
5. スプリングブートとスワッガーの統合はよりシンプルです

スプリングブートはswaggeruiを埋め込みます

ステップ

1.Jarパッケージの紹介

<Dependency> <groupId> io.springfox </groupid> <artifactid> springfox-swagger-ui </artifactid> <version> 2.2.2 </version> <scope> compile </scope> </dependency> <依存症> <groupid> io.springfox </groupid> springfox> springfof <バージョン> 2.2.2 </version> <scope>コンパイル</scope> </dependency>

2。スプリングブートに基づいてSwaggerConfigの構成

@configuration @enableSwagger2public class swaggerconfig {@bean public docket newsapi（）{// return new docket（documentationType.swagger_2）.apiinfo（apiinfo（））。 Docket Docket = new Docket（documentationType.swagger_2）; docket.enable（true）; docket.apiinfo（apiinfo（））。select（）。paths（pathselectors.any（））。build（）;ドケットを返します。 } private apiinfo apiinfo（）{return new apiinfobuilder（）。title（ "Order Center Test Platform"）。 .termsofserviceurl（ "http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?open"）.contact（ "test"）.license（ "china Red Starライセンスバージョン1.0"）。 }}

3。WebConfig構成手順

ここに注意を払う必要がある問題があります。 webmvcconfigureradapterを直接継承する代わりに、webconfigをwebmvcautoconfigurationAdapterを継承します。そうしないと、Swaggerページはリリースされません。

 @configuration @enablewebmvcpublic class webconfig extends webmvcautoconfigurationadapter {@override public void addcorsmappings（corsregistry registry）{registry.addmapping（ "/**"）; } @bean public static propertySourcesplaceholderconfigurer propertySourcesplaceholderconfigurer（）{return new PropertySourcesPlaceHolderConFigurer（）; } @bean public filter charateLencodingfilter（）{charplageencodingfilter charatelecodingfilter = new charperencodingfilter（）; charitiousencodingfilter.setencoding（ "utf-8"）; charitiousencodingfilter.setforceEncoding（true）; return charatelecodingfilter; } @bean public MappingJackson2HTTPMessageConverter Converter（）{MappingJackson2HttpmessageConverter converter = new MappingJackson2HttpmessageConverter（）;戻りコンバーター。 } @bean public Resolver getViewResolver（）{internalResourceViewResolver Resolver = new InternalResourceViewResolver（）; Resolver.setViewClass（jstlview.class）; Resolver.setPrefix（ "/jsp"）; Resolver.Setsuffix（ "。JSP"）;リゾルバーを返します。 } @Bean Public StandardServetMultiPartresolver getStandardServletMultipartresolver（）{return exe new StardentServletmultipartresolver（）; }}

4。Swaggeruiページアクセス

http：// localhost：8080/projectname/swagger-ui.html＃！//

上記はこの記事のすべての内容です。みんなの学習に役立つことを願っています。誰もがwulin.comをもっとサポートすることを願っています。