春ブーツが急速に発展しているので、展開、およびなど便利な機能が、私は春のブートユーザーの大部分は、RESTfulなAPIを構築するために使用されると信じています。また、目的は、通常、マルチパス端末によるRESTfulなAPIの理由を構築しており、これらの端子は、基礎となるビジネス・ロジックの多くを共有することができるので、我々は、抽象層は、同時に、モバイルウェブまたは遠位端の複数のサービスを提供します。
IOSの開発者、Androidの開発者やWeb開発:その結果、当社のRESTfulなAPIは、複数の開発者や複数の開発チームに直面する可能性があります。他のチームと頻繁にコミュニケーションを低減させるため、通常は開発中のコストで、我々はインターフェイスのすべての詳細を記録するために、伝統的な練習RESTfulなAPIドキュメントを作成します、しかし、このアプローチにはいくつかの問題があります。
多くのインターフェイス、および複合体の詳細は、それ自体で、これは下流の流行を不平、非常に困難なことである高品質の文書を作成するには、(HTTPリクエスト、HTTPヘッダ、HTTPリクエストのコンテンツなどのさまざまな種類を考慮する必要があります)。
時間が経つにつれて、絶えず変更インタフェースは、インタフェース文書を修正するために、すべての回で同期させなければならない、と、厳格な管理の仕組みが存在しない限り、二つの異なるコードを持つ文書がなく、メディアでは、そうでない場合は簡単に不整合が生じます。
上記この問題を解決するために、この記事は重い良きパートナーRESTfulなAPIのSwagger2をご紹介します、それは簡単に春ブーツに統合され、強い組織RESTfulなAPIドキュメントとSpring MVCのプログラムとすることができます。記述内容と実装コードに統合するには、そのメンテナンスのドキュメントので、コードを変更し、一つに統合され、私たちは簡単にコードのロジックを変更すると同時に、ドキュメントを変更することを可能にする一方でそれは、私たちが文書を作成した作業量を減らすことができます。またSwagger2のページには、それぞれのRESTfulなAPIをデバッグするための強力なテスト機能を提供します。以下に示すように、特定の結果:
以下、具体的に春ブーツ場合Swagger2の使用を記載しています。まず、我々はあなたがこのタイプのコンテンツを行っていない場合、読むことをお勧めします、達成するために春のRESTful APIプロジェクトの起動を必要とします
追加Swagger2依存
のpom.xml依存Swagger2に追加
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.2.2</version>
</dependency>
Swagger2の設定クラスを作成
Application.javaで同じレベルを設定クラスSwagger2 Swagger2を作成します。
@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.didispace.web"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2构建RESTful APIs")
.description("更多Spring Boot相关文章请关注:http://blog.didispace.com/")
.termsOfServiceUrl("http://blog.didispace.com/")
.contact("程序猿DD")
.version("1.0")
.build();
}
}
@Configurationアノテーションによって、コードに示すように、スプリングは、クラスコンフィギュレーションをロードできるようにします。そして、@ EnableSwagger2コメントでSwagger2を有効にします。
createRestApiドケット機能により豆を再作成した後、apiInfo()(文書の今ページ基本情報展示会)APIの基本的な情報を作成するために使用されます。select()関数を示すために闊歩に露出されたインターフェイスを制御するApiSelectorBuilder例を返すは、本実施形態では、走査を定義するために指定されたパッケージのパスを使用して、このパケットに定義されたすべての闊歩コントローラAPIをスキャンし、であることに加えて、文書の内容を(生成します@ ApiIgnore指定されたリクエスト)。
大企業のJAVASpringクラウドニーズB2B2C電子商取引プラットフォームのソースコードを内蔵したマイクロクラウドサービスを分散し、ペンギンBEGを追加してください:3536247259