فهرست منبع

增加swagger2

shuzheng 8 سال پیش
والد
کامیت
62dfdc670f

+ 6 - 0
zheng-cms/zheng-cms-admin/src/main/java/com/zheng/cms/admin/controller/manage/CmsCategoryController.java

@@ -5,6 +5,8 @@ import com.zheng.cms.dao.model.CmsCategory;
 import com.zheng.cms.dao.model.CmsCategoryExample;
 import com.zheng.cms.rpc.api.CmsCategoryService;
 import com.zheng.common.util.Paginator;
+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;
@@ -40,6 +42,7 @@ public class CmsCategoryController extends BaseController {
 	 * @param modelMap
 	 * @return
 	 */
+	@ApiOperation(value = "类目列表", notes = "获取类目列表并分页")
 	@RequestMapping("/list")
 	public String list(
 			@RequestParam(required = false, defaultValue = "1", value = "page") int page,
@@ -78,6 +81,9 @@ public class CmsCategoryController extends BaseController {
 	 * @param modelMap
 	 * @return
 	 */
+	@ApiOperation(value = "创建类目", notes = "根据CmsCategory对象创建类目")
+	@ApiImplicitParam(name = "cmsCategory", value = "类目实体cmsCategory", required = true, dataType = "CmsCategory")
+
 	@RequestMapping(value = "/add", method = RequestMethod.POST)
 	public String add(CmsCategory cmsCategory, ModelMap modelMap) {
 		long time = System.currentTimeMillis();

+ 26 - 0
zheng-common/pom.xml

@@ -176,6 +176,17 @@
             <artifactId>commons-fileupload</artifactId>
             <version>1.3.1</version>
         </dependency>
+        <!-- swagger2 -->
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>2.4.0</version>
+        </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>2.4.0</version>
+        </dependency>
         <!-- 常用工具包 -->
         <dependency>
             <groupId>commons-beanutils</groupId>
@@ -246,6 +257,21 @@
             <artifactId>fastjson</artifactId>
             <version>1.2.22</version>
         </dependency>
+        <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>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-annotations</artifactId>
+            <version>2.6.5</version>
+        </dependency>
         <!-- java mail -->
         <dependency>
             <groupId>javax.mail</groupId>

+ 3 - 0
zheng-common/src/main/resources/springMVC-servlet.xml

@@ -14,6 +14,7 @@
 	<!-- 扫描controller -->
 	<context:component-scan base-package="**.*controller" />
 	<context:annotation-config />
+	<bean id="swagger2Config" class="springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration"/>
 
 	<!-- 返回ResponseBody响应类型 -->
 	<mvc:annotation-driven>
@@ -53,6 +54,8 @@
 
 	<!-- 配置静态资源,不被DispatcherServlet处理,增加缓存时间 -->
 	<mvc:resources mapping="/resources/**" location="/resources/" cache-period="10" />
+	<mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
+	<mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>
 	
 	<!-- 上传文件配置 20*1024*1024即20M resolveLazily属性启用是为了推迟文件解析,以便捕获文件大小异常 -->
 	<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">