zhiyuxing
/
estateagents
Volgen 0
Ster 0
Vork 0
Code Kwesties 0 Pull-aanvragen 0 Publicaties 15 Wiki Activiteit
Bladeren bron

swagger

傅行帆 5 jaren geleden
bovenliggende
3ea8215ad9
commit
662fb5a6de
3 gewijzigde bestanden met toevoegingen van 90 en 0 verwijderingen
Zij-aan-zij weergave Toon Diff Stats
  1. 42
    0
      src/main/java/com/huiju/estateagents/controller/ExtendContentController.java
  2. 38
    0
      src/main/java/com/huiju/estateagents/controller/TaPolicyController.java
  3. 10
    0
      src/main/java/com/huiju/estateagents/controller/TdReportController.java

+ 42
- 0
src/main/java/com/huiju/estateagents/controller/ExtendContentController.java Bestand weergeven 

@@ -10,6 +10,10 @@ import com.huiju.estateagents.entity.TaBuildingDynamic;
10 10 
 import com.huiju.estateagents.service.IExtendContentService;
11 11 
 import com.huiju.estateagents.service.ITaBuildingDynamicService;
12 12 
 import com.huiju.estateagents.service.ITaBuildingService;
13 
+import io.swagger.annotations.Api;
14 
+import io.swagger.annotations.ApiImplicitParam;
15 
+import io.swagger.annotations.ApiImplicitParams;
16 
+import io.swagger.annotations.ApiOperation;
13 17 
 import org.apache.commons.lang3.StringUtils;
14 18 
 import org.slf4j.Logger;
15 19 
 import org.slf4j.LoggerFactory;

@@ -35,6 +39,7 @@ import java.time.LocalDateTime;
35 39 
  */
36 40 
 @RestController
37 41 
 @RequestMapping("/api")
42 
+@Api(value = "轮播图", tags = "轮播图")
38 43 
 public class ExtendContentController extends BaseController {
39 44
40 45 
     private final Logger logger = LoggerFactory.getLogger(ExtendContentController.class);

@@ -54,6 +59,16 @@ public class ExtendContentController extends BaseController {
54 59 
      * @param pageSize
55 60 
      * @return
56 61 
      */
62 
+    @ApiOperation(value = "后台轮播图列表", notes = "后台轮播图列表")
63 
+    @ApiImplicitParams({
64 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "第几页"),
65 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "一页多少行"),
66 
+            @ApiImplicitParam(dataTypeClass = String.class, name = "buildingId", paramType = "query",value = "项目id"),
67 
+            @ApiImplicitParam(dataTypeClass = String.class, name = "contentType", paramType = "query",value = "内容类型"),
68 
+            @ApiImplicitParam(dataTypeClass = String.class, name = "showPosition", paramType = "query",value = "发布位置"),
69 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "status", paramType = "query",value = "状态"),
70 
+            @ApiImplicitParam(dataTypeClass = String.class, name = "showType", paramType = "query",value = "发布类型")
71 
+    })
57 72 
     @RequestMapping(value="/admin/extendContent",method= RequestMethod.GET)
58 73 
     public ResponseBean extendContentList(@RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
59 74 
                                           @RequestParam(value ="pageSize",defaultValue = "10") Integer pageSize,

@@ -80,6 +95,16 @@ public class ExtendContentController extends BaseController {
80 95 
     /**
81 96 
      * 微信 开屏 / 轮播图
82 97 
      */
98 
+    @ApiOperation(value = "微信轮播图列表", notes = "微信轮播图列表")
99 
+    @ApiImplicitParams({
100 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "第几页"),
101 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "一页多少行"),
102 
+            @ApiImplicitParam(dataTypeClass = String.class, name = "buildingId", paramType = "query",value = "项目id"),
103 
+            @ApiImplicitParam(dataTypeClass = String.class, name = "contentType", paramType = "query",value = "内容类型"),
104 
+            @ApiImplicitParam(dataTypeClass = String.class, name = "targetId", paramType = "query",value = ""),
105 
+            @ApiImplicitParam(dataTypeClass = String.class, name = "contentId", paramType = "query",value = "内容ID"),
106 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "cityId", paramType = "query",value = "城市ID")
107 
+    })
83 108 
     @RequestMapping(value="/wx/extendContent/{showType}",method= RequestMethod.GET)
84 109 
     public ResponseBean extendContentListShowType(@PathVariable(value = "showType") String showType,
85 110 
                                                   @RequestParam(value = "showPosition", required = false) String showPosition,

@@ -98,6 +123,10 @@ public class ExtendContentController extends BaseController {
98 123 
      * @param extendContent 实体对象
99 124 
      * @return
100 125 
      */
126 
+    @ApiOperation(value = "后台轮播图保存", notes = "后台轮播图保存")
127 
+    @ApiImplicitParams({
128 
+            @ApiImplicitParam(dataType = "ExtendContent", name = "extendContent", paramType = "body",value = "轮播图内容")
129 
+    })
101 130 
     @RequestMapping(value="/admin/extendContent",method= RequestMethod.POST)
102 131 
     public ResponseBean extendContentAdd(@RequestBody ExtendContent extendContent, HttpServletRequest request){
103 132 
         Integer cityId = iTaBuildingService.getCityById(extendContent.getBuildingId());

@@ -113,6 +142,10 @@ public class ExtendContentController extends BaseController {
113 142 
      * 根据id删除对象
114 143 
      * @param id  实体ID
115 144 
      */
145 
+    @ApiOperation(value = "后台轮播图删除", notes = "后台轮播图删除")
146 
+    @ApiImplicitParams({
147 
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "payh",value = "轮播图id")
148 
+    })
116 149 
     @ResponseBody
117 150 
     @RequestMapping(value="/admin/extendContent/{id}", method= RequestMethod.DELETE)
118 151 
     public ResponseBean extendContentDelete(@PathVariable Integer id){

@@ -137,6 +170,11 @@ public class ExtendContentController extends BaseController {
137 170 
      * @param extendContent 实体对象
138 171 
      * @return
139 172 
      */
173 
+    @ApiOperation(value = "后台轮播图保存", notes = "后台轮播图保存")
174 
+    @ApiImplicitParams({
175 
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "payh",value = "轮播图id"),
176 
+            @ApiImplicitParam(dataType = "ExtendContent", name = "extendContent", paramType = "body",value = "轮播图内容")
177 
+    })
140 178 
     @RequestMapping(value="/admin/extendContent/{id}",method= RequestMethod.PUT)
141 179 
     public ResponseBean extendContentUpdate(@PathVariable Integer id,
142 180 
                                         @RequestBody ExtendContent extendContent,HttpServletRequest request){

@@ -163,6 +201,10 @@ public class ExtendContentController extends BaseController {
163 201 
      * 根据id查询对象
164 202 
      * @param id  实体ID
165 203 
      */
204 
+    @ApiOperation(value = "后台轮播图查询", notes = "后台轮播图查询")
205 
+    @ApiImplicitParams({
206 
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "payh",value = "轮播图id")
207 
+    })
166 208 
     @RequestMapping(value="/admin/extendContent/{id}",method= RequestMethod.GET)
167 209 
     public ResponseBean extendContentGet(@PathVariable Integer id){
168 210 
         ResponseBean responseBean = new ResponseBean();

+ 38
- 0
src/main/java/com/huiju/estateagents/controller/TaPolicyController.java Bestand weergeven 

@@ -10,6 +10,10 @@ import com.huiju.estateagents.common.JWTUtils;
10 10 
 import com.huiju.estateagents.entity.TdCity;
11 11 
 import com.huiju.estateagents.service.ITdCityService;
12 12 
 import com.huiju.estateagents.service.ITaPolicyService;
13 
+import io.swagger.annotations.Api;
14 
+import io.swagger.annotations.ApiImplicitParam;
15 
+import io.swagger.annotations.ApiImplicitParams;
16 
+import io.swagger.annotations.ApiOperation;
13 17 
 import org.slf4j.Logger;
14 18 
 import org.slf4j.LoggerFactory;
15 19 
 import org.springframework.beans.factory.annotation.Autowired;

@@ -35,6 +39,7 @@ import java.time.LocalDateTime;
35 39 
  */
36 40 
 @RestController
37 41 
 @RequestMapping("/api")
42 
+@Api(value = "政策维护", tags = "政策维护")
38 43 
 public class TaPolicyController extends BaseController {
39 44
40 45 
     private final Logger logger = LoggerFactory.getLogger(TaPolicyController.class);

@@ -52,6 +57,12 @@ public class TaPolicyController extends BaseController {
52 57 
      * @param pageSize
53 58 
      * @return
54 59 
      */
60 
+    @ApiOperation(value = "后台政策维护列表", notes = "后台政策维护列表")
61 
+    @ApiImplicitParams({
62 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "第几页"),
63 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "一页多少行"),
64 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "cityId", paramType = "query",value = "城市ID")
65 
+    })
55 66 
     @RequestMapping(value="/admin/taPolicy",method= RequestMethod.GET)
56 67 
     public ResponseBean taPolicyList(@RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
57 68 
 									 @RequestParam(value ="pageSize",defaultValue = "10") Integer pageSize,

@@ -82,6 +93,12 @@ public class TaPolicyController extends BaseController {
82 93 
      * @param pageSize
83 94 
      * @return
84 95 
      */
96 
+    @ApiOperation(value = "微信政策维护列表", notes = "微信政策维护列表")
97 
+    @ApiImplicitParams({
98 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "第几页"),
99 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "一页多少行"),
100 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "cityId", paramType = "query",value = "城市ID")
101 
+    })
85 102 
     @RequestMapping(value="/wx/taPolicy",method= RequestMethod.GET)
86 103 
     public ResponseBean taPolicyListCity(@RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
87 104 
                                      @RequestParam(value ="pageSize",defaultValue = "10") Integer pageSize,

@@ -110,6 +127,10 @@ public class TaPolicyController extends BaseController {
110 127 
      * @param taPolicy 实体对象
111 128 
      * @return
112 129 
      */
130 
+    @ApiOperation(value = "后台政策维护保存", notes = "后台政策维护保存")
131 
+    @ApiImplicitParams({
132 
+            @ApiImplicitParam(dataType = "TaPolicy", name = "taPolicy", paramType = "body",value = "政策数据")
133 
+    })
113 134 
     @RequestMapping(value="/admin/taPolicy",method= RequestMethod.POST)
114 135 
     public ResponseBean taPolicyAdd(@RequestBody TaPolicy taPolicy, HttpServletRequest request){
115 136 
         ResponseBean responseBean = new ResponseBean();

@@ -144,6 +165,10 @@ public class TaPolicyController extends BaseController {
144 165 
      * 根据id删除对象
145 166 
      * @param id  实体ID
146 167 
      */
168 
+    @ApiOperation(value = "后台政策维护删除", notes = "后台政策维护删除")
169 
+    @ApiImplicitParams({
170 
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "path",value = "政策数据ID")
171 
+    })
147 172 
     @ResponseBody
148 173 
     @RequestMapping(value="/admin/taPolicy/{id}", method= RequestMethod.DELETE)
149 174 
     public ResponseBean taPolicyDelete(@PathVariable Integer id){

@@ -169,6 +194,11 @@ public class TaPolicyController extends BaseController {
169 194 
      * @param taPolicy 实体对象
170 195 
      * @return
171 196 
      */
197 
+    @ApiOperation(value = "后台政策维护修改", notes = "后台政策维护修改")
198 
+    @ApiImplicitParams({
199 
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "path",value = "政策数据ID"),
200 
+            @ApiImplicitParam(dataType = "TaPolicy", name = "taPolicy", paramType = "body",value = "政策数据")
201 
+    })
172 202 
     @RequestMapping(value="/admin/taPolicy/{id}",method= RequestMethod.PUT)
173 203 
     public ResponseBean taPolicyUpdate(@PathVariable Integer id,
174 204 
                                         @RequestBody TaPolicy taPolicy,

@@ -203,6 +233,10 @@ public class TaPolicyController extends BaseController {
203 233 
      * 根据id查询对象
204 234 
      * @param id  实体ID
205 235 
      */
236 
+    @ApiOperation(value = "后台政策维护查询", notes = "后台政策维护查询")
237 
+    @ApiImplicitParams({
238 
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "path",value = "政策数据ID")
239 
+    })
206 240 
     @RequestMapping(value="/admin/taPolicy/{id}",method= RequestMethod.GET)
207 241 
     public ResponseBean taPolicyGet(@PathVariable Integer id){
208 242 
         ResponseBean responseBean = new ResponseBean();

@@ -219,6 +253,10 @@ public class TaPolicyController extends BaseController {
219 253 
      * 根据id查询对象
220 254 
      * @param id  实体ID
221 255 
      */
256 
+    @ApiOperation(value = "微信政策维护查询", notes = "微信政策维护查询")
257 
+    @ApiImplicitParams({
258 
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "path",value = "政策数据ID")
259 
+    })
222 260 
     @RequestMapping(value="/wx/taPolicy/{id}",method= RequestMethod.GET)
223 261 
     public ResponseBean taPolicyGetWx(@PathVariable Integer id){
224 262 
         ResponseBean responseBean = new ResponseBean();

+ 10
- 0
src/main/java/com/huiju/estateagents/controller/TdReportController.java Bestand weergeven 

@@ -6,6 +6,10 @@ import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
6 6 
 import com.huiju.estateagents.base.ResponseBean;
7 7 
 import com.huiju.estateagents.entity.TdReport;
8 8 
 import com.huiju.estateagents.service.ITdReportService;
9 
+import io.swagger.annotations.Api;
10 
+import io.swagger.annotations.ApiImplicitParam;
11 
+import io.swagger.annotations.ApiImplicitParams;
12 
+import io.swagger.annotations.ApiOperation;
9 13 
 import org.slf4j.Logger;
10 14 
 import org.slf4j.LoggerFactory;
11 15 
 import org.springframework.beans.factory.annotation.Autowired;
 
@@ -28,6 +32,7 @@ import com.huiju.estateagents.base.BaseController;
28 32 
  */
29 33 
 @RestController
30 34 
 @RequestMapping("/api")
35 
+@Api(value = "客户留言", tags = "客户留言")
31 36 
 public class TdReportController extends BaseController {
32 37
33 38 
     private final Logger logger = LoggerFactory.getLogger(TdReportController.class);
 
@@ -42,6 +47,11 @@ public class TdReportController extends BaseController {
42 47 
      * @param pageSize
43 48 
      * @return
44 49 
      */
50 
+    @ApiOperation(value = "后台客户留言列表", notes = "后台客户留言列表")
51 
+    @ApiImplicitParams({
52 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "第几页"),
53 
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "一页多少行")
54 
+    })
45 55 
     @RequestMapping(value="/admin/tdReports",method= RequestMethod.GET)
46 56 
     public ResponseBean tdReportList(@RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
47 57 
                                      @RequestParam(value ="pageSize",defaultValue = "10") Integer pageSize){