說明：這篇筆記參考了下面的部落格，感謝博主。

第 1 步： 引入相關的依賴。

<dependency>
    <groupId>com.mangofactory</groupId>
    <artifactId>swagger-springmvc</artifactId>
    <version>1.0.2</version>
</dependency>
<dependency>
    <groupId>org.codehaus.jackson</groupId>
 

    <artifactId>jackson-mapper-asl</artifactId>
    <version>1.9.13</version>
</dependency>
<dependency>
    <groupId>org.codehaus.jackson</groupId>
    <artifactId>jackson-core-asl</artifactId>
    <version>1.9.13</version>
</dependency
 
>

附：springboot 相關程式碼

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.3.1.RELEASE</version>
</parent>


<dependency>
    <groupId>org.springframework.boot</groupId
 
>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

第 2 步：在 springboot 的啟動類中加入相關的程式碼

/**
 * Hello world!
 */
@EnableSwagger
@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }


    private SpringSwaggerConfig springSwaggerConfig;

    /**
     * Required to autowire SpringSwaggerConfig
     */
    @Autowired
    public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig) {
        this.springSwaggerConfig = springSwaggerConfig;
    }


    /**
     * Every SwaggerSpringMvcPlugin bean is picked up by the swagger-mvc
     * framework - allowing for multiple swagger groups i.e. same code base
     * multiple swagger resource listings.
     */
    @Bean
    public SwaggerSpringMvcPlugin customImplementation() {
        return new SwaggerSpringMvcPlugin(this.springSwaggerConfig).apiInfo(apiInfo()).includePatterns(".*?");
    }

    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfo(
                "李威測試使用的頁面介面文件", // App Service API
                "副標題",
                "111111111111111111111111",
                "[email protected]",
                "2222222222222222222222222222",
                "3333333333333333333333333333");
        return apiInfo;
    }

}

第 3 步：在程式碼的控制類中加入相關的註解

@RestController
public class SampleController {


    @RequestMapping(value = "/hello")
    @ApiOperation(value = "新增使用者",httpMethod ="POST", response = UserBean.class,notes = "HelloWorld")
    public UserBean hello(@ApiParam(required = true,name = "paramData",value = "使用者資訊 json 資料") String paramData){
        UserBean userBean = new UserBean();
        userBean.setUsername("liwei");
        userBean.setPassword("123456");
        return userBean;
    }
}

說明：
其中@ApiOperation和@ApiParam為新增的API相關注解，各引數說明如下：
@ApiOperation(value = “介面說明”, httpMethod = “介面請求方式”, response = “介面返回引數型別”, notes = “介面釋出說明”；其他引數可參考原始碼；
@ApiParam(required = “是否必須引數”, name = “引數名稱”, value = “引數具體描述”

第 4 步：
在 GitHub 上下載 SwaggerUI
專案（https://github.com/swagger-api/swagger-ui），將dist下所有內容拷貝到本地專案webapp下面，結果目錄如下圖所示：
修改index.html

將index.html中

http://petstore.swagger.wordnik.com/v2/swagger.json

修改為

http://localhost:8080/{projectname}/api-docs

到此為止，所有配置完成，啟動你的專案，訪問

http://localhost:8086/swagger/index.html

即可看到如下所示頁面：

公司內網內測專案