spring boot : 集成swagger2 (REST详细设计文档)

1.     添加依赖

       <dependency>

           <groupId>io.springfox</groupId>

           <artifactId>springfox-swagger2</artifactId>

           <version>2.6.1</version>

       </dependency>

       <dependency>

           <groupId>io.springfox</groupId>

           <artifactId>springfox-swagger-ui</artifactId>

           <version>2.6.1</version>

       </dependency>

2.     创建swagger2配置类

package com.svw.tbox.tcloud.user.provider;

 

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;

import springfox.documentation.builders.PathSelectors;

import springfox.documentation.builders.RequestHandlerSelectors;

import springfox.documentation.service.ApiInfo;

import springfox.documentation.service.Contact;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

 

@Configuration

@EnableSwagger2

publicclass Swagger2 {

    /**

     * 通过createRestApi函数创建DocketBean之后,

     * apiInfo()用来创建该Api的基本信息(这些基本信息会展现在文档页面中)。

     * select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现,

     * 本例采用指定扫描的包路径来定义,

     * Swagger会扫描该包下所有Controller定义的API

     * 并产生文档内容(除了被@ApiIgnore指定的请求)。

     *

     * @return

     */

    @Bean

    public Docket createRestApi() {

        returnnew Docket(DocumentationType.SWAGGER_2)

                .apiInfo(apiInfo())

                .select()

                .apis(RequestHandlerSelectors.basePackage("com.svw.tbox.tcloud.user.provider.controller"))

                .paths(PathSelectors.any())

                .build();

    }

 

    /**

     * 用来创建该Api的基本信息(这些基本信息会展现在文档页面中)

     *

     * @return

     */

    private ApiInfo apiInfo() {

        returnnew ApiInfoBuilder()

                .title("micro SERVICE RESTful-APIs")

                .description("Restful-API文档,POST添加,GET获取,PUT修改,DELETE删除")

//                .termsOfServiceUrl("http://localhost:8000/swagger-ui.html") //请求swagger-ui.html

                .contact(new Contact(

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值