swagger

src/main/java/com/huiju/estateagents/controller/TaNewsController.java

@@ -13,6 +13,9 @@ import com.huiju.estateagents.service.ITaBuildingService;
 import com.huiju.estateagents.service.ITaNewsService;
 import com.huiju.estateagents.service.ITaPersonService;
 import com.huiju.estateagents.service.ITaSaveService;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.checkerframework.checker.units.qual.A;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -62,6 +65,14 @@ public class TaNewsController extends BaseController {
      * @param pageSize
      * @return
      */
+    @ApiOperation(value = "资讯列表", notes = "资讯列表")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "第几页"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "一页多少行"),
+            @ApiImplicitParam(dataTypeClass = String.class, name = "buildingId", paramType = "query",value = "项目id"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "newsTypeId", paramType = "query",value = "资讯类型id"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "newsStatus", paramType = "query",value = "状态")
+    })
     @RequestMapping(value="/admin/taNews",method= RequestMethod.GET)
     public ResponseBean taNewsList(HttpServletRequest request,
                                    @RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
@@ -108,6 +119,10 @@ public class TaNewsController extends BaseController {
      * @param taNews 实体对象
      * @return
      */
+    @ApiOperation(value = "保存资讯", notes = "保存资讯")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "TaNews", name = "taNews", paramType = "body",value = "资讯详细数据")
+    })
     @RequestMapping(value="/admin/taNews",method= RequestMethod.POST)
     public ResponseBean taNewsAdd(@RequestBody TaNews taNews, HttpServletRequest request){
         Integer cityId = iTaBuildingService.getCityById(taNews.getBuildingId());
@@ -134,6 +149,11 @@ public class TaNewsController extends BaseController {
      * @param taNews 实体对象
      * @return
      */
+    @ApiOperation(value = "修改资讯", notes = "修改资讯")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "TaNews", name = "taNews", paramType = "body",value = "资讯数据"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "taNews", paramType = "path", value = "资讯id")
+    })
     @RequestMapping(value="/admin/taNews/{id}",method= RequestMethod.PUT)
     public ResponseBean taNewsUpdate(@PathVariable Integer id,
                                         @RequestBody TaNews taNews,
@@ -150,6 +170,10 @@ public class TaNewsController extends BaseController {
      * 根据id查询对象
      * @param id  实体ID
      */
+    @ApiOperation(value = "咨询详情", notes = "咨询详情")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "path",value = "资讯id")
+    })
     @RequestMapping(value="/admin/taNews/{id}",method= RequestMethod.GET)
     public ResponseBean taNewsGet(@PathVariable Integer id){
         ResponseBean responseBean = iTaNewsService.getTaNewsById(id);

src/main/java/com/huiju/estateagents/controller/TaNewsTypeController.java

@@ -7,6 +7,10 @@ import com.huiju.estateagents.base.BaseController;
 import com.huiju.estateagents.base.ResponseBean;
 import com.huiju.estateagents.entity.TaNewsType;
 import com.huiju.estateagents.service.ITaNewsTypeService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -30,6 +34,7 @@ import javax.servlet.http.HttpServletRequest;
  */
 @RestController
 @RequestMapping("/api")
+@Api(value = "资讯类型", tags = "资讯类型")
 public class TaNewsTypeController extends BaseController {
 
     private final Logger logger = LoggerFactory.getLogger(TaNewsTypeController.class);
@@ -44,6 +49,12 @@ public class TaNewsTypeController extends BaseController {
      * @param pageSize
      * @return
      */
+    @ApiOperation(value = "查询资讯类型", notes = "查询资讯类型")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageNum", paramType = "query",value = "第几页"),
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "pageSize", paramType = "query",value = "一页多少行"),
+            @ApiImplicitParam(dataTypeClass = String.class, name = "buildingId", paramType = "query",value = "项目id")
+    })
     @RequestMapping(value="/admin/taNewsType",method= RequestMethod.GET)
     public ResponseBean taNewsTypeList(@RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
                                        @RequestParam(value ="pageSize",defaultValue = "10") Integer pageSize,
@@ -58,6 +69,10 @@ public class TaNewsTypeController extends BaseController {
      * @param taNewsType 实体对象
      * @return
      */
+    @ApiOperation(value = "保存资讯类型", notes = "保存资讯类型")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "TaNewsType", name = "taNewsType", paramType = "body",value = "资讯类型数据")
+    })
     @RequestMapping(value="/admin/taNewsType",method= RequestMethod.POST)
     public ResponseBean taNewsTypeAdd(@RequestBody TaNewsType taNewsType, HttpServletRequest request){
         ResponseBean responseBean = iTaNewsTypeService.addTaNewsType(taNewsType, getOrgId(request));
@@ -81,6 +96,11 @@ public class TaNewsTypeController extends BaseController {
      * @param taNewsType 实体对象
      * @return
      */
+    @ApiOperation(value = "修改资讯类型", notes = "根据ID修改资讯类型")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "TaNewsType", name = "taNewsType", paramType = "body",value = "资讯类型数据"),
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "path",value = "资讯id")
+    })
     @RequestMapping(value="/admin/taNewsType/{id}",method= RequestMethod.PUT)
     public ResponseBean taNewsTypeUpdate(@PathVariable Integer id,
                                         @RequestBody TaNewsType taNewsType, HttpServletRequest request){
@@ -94,6 +114,10 @@ public class TaNewsTypeController extends BaseController {
      * 根据id查询对象
      * @param id  实体ID
      */
+    @ApiOperation(value = "咨询类型详情", notes = "咨询类型详情")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataType = "Integer", name = "id", paramType = "path",value = "资讯id")
+    })
     @RequestMapping(value="/admin/taNewsType/{id}",method= RequestMethod.GET)
     public ResponseBean taNewsTypeGet(@PathVariable Integer id){
         ResponseBean responseBean = iTaNewsTypeService.getTaNewsTypeById(id);