あなたの会社がSwaggerを使用していないか、Swaggerを聞いたことがない場合は、このブログを急いで学びます。
まず、Swagger:Swaggerはバックエンド開発のための魔法のツールであり、フロントエンドコミュニケーションのためのチャネルです。 Swaggerで何ができますか?まず第一に、基本的に将来のユニットテストに別れを告げることができます。第二に、インターフェイスドキュメントを作成する必要はなく、ドキュメントを作成した後にドキュメントを維持する必要はありません。 SwaggerはHTTP要求を完全にシミュレートでき、着信パラメーターと発信パラメーターと実際の条件の違いはほぼゼロです。これを言って、いくつかの情報を作成しましょう!
統合された4部構成:
ステップ1: 2つの依存関係をインポートします。あなたがMavenプロジェクトでない場合は、JARパッケージを探すことができます。必要なのは2つだけであることを忘れないでください。他のチュートリアルで7〜8個を紹介したことがわかりました。これは無駄です。
<Dependency> groupId> io.springfox </groupid> <artifactid> springfox-swagger2 </artifactid> <version> 2.6.1 </version> </dependency> <dependency> <groupid> io.springfox </groupid> <artifactid> springfox-swox-verion </artificid>
ステップ2:クラスを追加します(次の1つをコピーして、パッケージ名とアドレスを変更できることに注意してください)
/** * swagger Configuration * @Author WQ * @Since 2017-05-16 */ @enableWebmvc @configurationpublic class swaggerconfig {@bean public docketcreaterapi(){return new Docket(documentationtype.swagher_2).apiinfo(apiinfo()。 .apis(requesthandlerselectors.basepackage( "com.z*.b .c*.controller"))//パッケージ名はここでpaths(pathselectors.any()).build()を変更することに注意してください。 } private apiinfo apiinfo(){return new apiinfobuilder().title( "interface list v1.1.0")// any any ant little.description( "interface test")//あなた自身のIP:port .contact( "laowu")//それは重要ではありません(ここに著者のエイリアスです).version( "1.1.0").build(); }}ステップ3: MVC構成ファイルに次の構成を追加します。ファイルはDispatcher.xmlと呼ばれるかもしれません! (コピーするだけで、変更は必要ありません)
<MVC:リソースマッピング= "swagger-ui.html" location = "classpath:/meta-inf/resources/"/>> <mvc:resources mapping = "/webjars/**" location = "classpath:/meta-inf/resources/webjars/>>
ステップ4:メソッドとパラメーターに注釈を追加します
方法:
@apioperation(value = "Tutorial"、httpmethod = "post"、notes = "Tutorial")
レジストリに入れてください:
@apiparam(必須= true、name = "test"、value = "チュートリアルパラメーター")
友達がよくわからないのではないかと心配なので、写真を撮りましょう!
ステップ5:サービスを開始し、ブラウザに入力します。
http:// ip:port/swagger-ui.html
次の画面が表示されることは、タスクが完了することを意味します。
注:プロジェクトでインターセプターを使用している場合は、Swaggerリソースをリリースしてください(次の構成を直接コピーできます。V2は疑わないでください)
<MVC:マッピングパス= "/swagger*/**"> </mvc:除外> <mvc:除外path = "/v2/**"> </mvc:explude-mapping> <mvc:除外path = "/webjars/** **"> </mvc:exclude-mapping>
上記はこの記事のすべての内容です。みんなの学習に役立つことを願っています。誰もがwulin.comをもっとサポートすることを願っています。