1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

package com.springboot.example;

//swagger2的配置檔案，在專案的啟動類的同級檔案建立

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

public class Swagger2 {

//swagger2的配置檔案，這裡可以配置swagger2的一些基本的內容，比如掃描的包等等

    @Bean

    public Docket createRestApi() {

        return new Docket(DocumentationType.SWAGGER_2)

                .apiInfo(apiInfo())

                .select()

                //為當前包路徑

                .apis(RequestHandlerSelectors.basePackage("com.springboot.example.Controller"))

                .paths(PathSelectors.any())

                .build();

    }

    //構建 api文件的詳細資訊函式,注意這裡的註解引用的是哪個

    private ApiInfo apiInfo() {

        return new ApiInfoBuilder()

                //頁面標題

                .title("Spring Boot 測試使用 Swagger2 構建RESTful API")

                //建立人

                .contact(new Contact("MarryFeng", "http://www.baidu.com", ""))

                //版本號

                .version("1.0")

                //描述

                .description("API 描述")

                .build();

    }

}

1

2

@Configuration

@EnableSwagger2<br>這兩個註解，一個是swagger2的配置，一個是專案啟動的時候啟動swagger2.<br>具體什麼意思看下程式碼就知道了。

1

2

//為當前包路徑

<span style="color: #ff0000">.apis(RequestHandlerSelectors.basePackage("com.springboot.example.Controller"))</span><br><span style="color: #ff0000">這個包指的是我們在哪些類中使用swagger2來測試。</span>

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

package com.springboot.example.Controller;

import com.springboot.example.Service.StudentService;

import com.springboot.example.entity.Student;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiImplicitParam;

import io.swagger.annotations.ApiOperation;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RestController;

/**

 * Created by Administrator on 2017/9/13.

 */

@RestController

@RequestMapping("api")

@Api("swaggerDemoController相關的api")

public class SwaggerDemoController {

    @Autowired

    private StudentService studentService;

    private static final Logger logger= LoggerFactory.getLogger(SwaggerDemoController.class);

    @ApiOperation(value = "根據id查詢學生資訊", notes = "查詢資料庫中某個的學生資訊")

    @ApiImplicitParam(name = "id", value = "學生ID", paramType = "path", required = true, dataType = "Integer")

    @RequestMapping(value = "/{id}", method = RequestMethod.GET)

    public Student getStudent(@PathVariable int id) {

        logger.info("開始查詢某個學生資訊");

        return studentService.selectStudentById(id);

    }

}