本文章更新頁請至：http://blog.csdn.net/MikeLC7/article/details/75088123

之前專案的介面文件都是手動編寫Word文件來做，製作成本較高，並且在進行版本迭代的時候進行標註和說明不是很方便，後來發現Swagger之後進行了簡單的操作。
截止目前還未深度使用，本文僅記錄初次使用Swagger的過程和遇到的問題，後續進行補充。
前言：
當前專案使用SpringMVC，整合Swagger2

Step1：
新增依賴包

  <textarea readonly="readonly" name="code" class="java"> 
	<!--springfox 相關依賴 start-->
	<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>
	<!--springfox 相關依賴 end-->
        <!-- 映入JSON -->  
        <dependency>
	      <groupId>com.fasterxml.jackson.core</groupId>
	      <artifactId>jackson-core</artifactId>
	      <version>2.6.5</version>
        </dependency>
	<dependency>
	      <groupId>com.fasterxml.jackson.core</groupId>
	      <artifactId>jackson-databind</artifactId>
	      <version>2.6.5</version>
	      <!-- <scope>provided</scope> -->
	 </dependency>
	 <!-- 映入JSON -->
		</textarea>
 

Step2:
新增Spring配置檔案中的相關配置：

<textarea readonly="readonly" name="code" class="java"> 
	<!-- swagger start-->
	<!-- 啟動註解 -->
        <mvc:annotation-driven />
        <!-- 配置Swagger相關靜態資源 -->
	<mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
	<mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>
	<!-- 引用Swagger 預設配置 -->
 	<bean class="springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration" id="swagger2Config"/> 
	<!-- 新增Swagger2 掃描目錄 -->
	<context:component-scan base-package="com.train.action" ></context:component-scan>
        <!-- swagger end -->
        </textarea>
 

備註：本次使用的Swagger相關配置是Swagger的預設配置，也可以通過

<textarea readonly="readonly" name="code" class="XML"> 
<bean class="com.swagger.doc.MySwaggerConfig" />
</textarea>

已上的方式自定義swagger配置類並配置bean。

step3:
確定Spring的url-pattern對映關係為 /:

  <textarea readonly="readonly" name="code" class="XML"> 
  <!-- Spring MVC servlet -->  
  <servlet>
    <servlet-name>spring</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:/config/spring-mvc.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
    <async-supported>true</async-supported>
  </servlet>
  <servlet-mapping>
    <servlet-name>spring</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping> 
  </textarea>
 

備註：spring的對映一定要是/，否則swagger2中需要引入相關靜態資源可能會因為找不到而導致頁面載入失敗。
例如：
http://localhost/swagger-resources/configuration/ui Failed to load resource: the server responded with a status of 404 (Not Found)


以上為本次記錄的全部內容，註解相關API請移步官網參考，因沒有正式深度使用，記錄的內容較為粗淺，後續正式使用後會進行更新。