統合swagger2のと春ブーツ

　　プロジェクトのインタフェースのドキュメントには、間違いなく、作業の効率を低下させ、各時間終了インターフェースはまた、これらの文書を整理するために必要な文書を書くためのバックエンドとして、前後端をドッキングするための重要なツールです。方法があるなら、あなたは多くが容易になりますコードやプラグインツールを書い同時に文書を書くことができます。swagger2 APIは、このような開発フレームワークです。

　　swagger2は、同じ一般的なアプローチ、動的に文書を生成するための侵襲的なインターフェイス、インターフェイス、スタッフの利便性の終わりの前と後のビューに基づいています。

swagger2構成

1、swagger2は、フレームワークAPIですので、彼はプロジェクトにjarファイルをインポートするために彼の必要性を使用しています

ポンポンファイルに依存して追加

<依存性> 
    <のgroupId> io.springfox </のgroupId> 
    <たartifactId> springfox-swagger2 </たartifactId> 
    <バージョン> 2.6.1 </バージョン> 
</依存> 

<依存性> 
    <のgroupId> io.springfox </のgroupId> 
    <たartifactId> springfox-闊歩-UI </たartifactId> 
    <バージョン> 2.6.1 </バージョン> 
</依存>

2.構成クラスSwagger2を作成します。

@Configuration
 パブリック クラスSwaggerConfig { 
    
    @Bean 
    公衆整理番号createRestApi（）{
         戻り 新しい新しい整理番号（DocumentationType.SWAGGER_2）.apiInfo（apiInfoを（））。（SELECT）
                （RequestHandlerSelectors.basePackage（.apis "com.example.demo.controller" ））.paths（PathSelectors.any（））
                .build（）; 
    } 
    / ** 
     *一部のインターフェイスのタイトルと説明の文書、追加
     * / 
    プライベートapiInfo apiInfoを（）{
         返す 新しい新しい。ApiInfoBuilder（）タイトル（「springbootをし、闊歩統合"）.DESCRIPTION（"ドキュメント・インターフェイス」）
                .termsOfServiceUrl（"测试のURL"）の接触（ "taizhu"）のバージョン（ "1.0"。。）.build（）; 
    } 
}

3、起動クラスにEnableSwagger2 @注釈を追加

これは、設定上の私たちの闊歩を終えました。します。http：// localhost：あなたが動的に生成さ見ることができます8080 /威張っ-ui.html＃/ APIドキュメントを闊歩アドレスバーに、プロジェクトを開始します。

swagger2コメント

swagger2ので、すべては私たちが習得しなければならない、意味は何コメント、ベースの注釈を開発しています。

CSDNで見るノートと説明のすべてを比較します。https://blog.csdn.net/weixin_41846320/article/details/82970204

毎日の記録8.6

統合swagger2のと春ブーツ

swagger2構成

swagger2コメント

おすすめ