springmvc輕鬆整合springfox

springfox介紹html

Springfox的前身是swagger-springmvc,是一個開源的API doc框架,能夠將咱們的Controller的方法以文檔的形式展示。java

1.引入springfox依賴jar包git

<!-- springfox -->
			<dependency>
				<groupId>io.springfox</groupId>
				<artifactId>springfox-swagger2</artifactId>
				<version>2.0.2</version>
			</dependency>
			<dependency>
				<groupId>com.fasterxml.jackson.core</groupId>
				<artifactId>jackson-annotations</artifactId>
				<version>2.4.4</version>
			</dependency>
			<dependency>
				<groupId>com.fasterxml.jackson.core</groupId>
				<artifactId>jackson-core</artifactId>
				<version>2.4.4</version>
			</dependency>
            <dependency>
				<groupId>com.fasterxml.jackson.core</groupId>
				<artifactId>jackson-databind</artifactId>
				<version>${jackson.version}</version>
			</dependency>

2.自定義swagger github

SwaggerConfig.java
/**
 * The type Swagger config.
 */

import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * The type Swagger config.
 *
 * @author weiyonghua
 */
@EnableWebMvc
@EnableSwagger2
public class SwaggerConfig {

}

3.spring容器加載 applicationContext.xmlweb

<!--springfox swagger-->
    <bean class="com.chuyan.common.swagger.SwaggerConfig"/>

4.https://github.com/swagger-api/swagger-ui.git 下載swagger-ui中的dist文件夾引入項目。spring

5.修改swagger-ui項目中的index.html文件url地址 api

6.項目訪問地址 http://localhost:8080/${project.name}/swagger/index.htmlmvc

7.swagger註解使用參考https://my.oschina.net/zzuqiang/blog/793606app

相關文章
相關標籤/搜索