swagger 项目类型

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

@@ -11,6 +11,10 @@ import com.huiju.estateagents.service.ITaBuildingService;
 import com.huiju.estateagents.service.ITaPersonService;
 import com.huiju.estateagents.service.ITaSaveService;
 import com.huiju.estateagents.service.ITdCityService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.apache.ibatis.annotations.Param;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.format.annotation.DateTimeFormat;
@@ -35,6 +39,7 @@ import java.util.Map;
  */
 @RestController
 @RequestMapping("/api")
+@Api(value = "楼盘")
 public class TaBuildingController extends BaseController {
 
     @Autowired
@@ -53,6 +58,10 @@ public class TaBuildingController extends BaseController {
      * @return
      */
     @GetMapping("/admin/buildingSelectId/{id}")
+    @ApiOperation(value = "项目详情", notes = "项目详情")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "path", name = "id", value = "项目id")
+    })
     public ResponseBean buildingSelectId(@PathVariable(value = "id") String id){
         return taBuildingService.buildingSelectId(id);
     }
@@ -65,6 +74,18 @@ public class TaBuildingController extends BaseController {
      * @param code
      * @return
      */
+    @ApiOperation(value = "项目列表 查询所有有效的", notes = "项目列表 查询所有有效的")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "pageNum", value = "第几页"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "pageSize", value = "一页多少行"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "name", value = "项目名称"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "code", value = "项目编号"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "startDate", value = "开盘时间"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "buildingStatus", value = "项目状态"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "marketStatus", value = "销售状态"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "cityId", value = "城市Id"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "isMain", value = "是否主推项目"),
+    })
     @GetMapping("/admin/buildinglist")
     public ResponseBean buildingList(@RequestParam(value = "pageNum", defaultValue = "1")Integer pageNum,
                                      @RequestParam(value = "pageSize", defaultValue = "10")Integer pageSize,
@@ -87,6 +108,18 @@ public class TaBuildingController extends BaseController {
      * @param code
      * @return
      */
+    @ApiOperation(value = "项目列表", notes = "项目列表")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "pageNum", value = "第几页"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "pageSize", value = "一页多少行"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "name", value = "项目名称"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "code", value = "项目编号"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "startDate", value = "开盘时间"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "buildingStatus", value = "项目状态"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "marketStatus", value = "销售状态"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "cityId", value = "城市Id"),
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "query", name = "isMain", value = "是否主推项目"),
+    })
     @GetMapping("/admin/buildinglist/select")
     public ResponseBean buildingListSelect(@RequestParam(value = "pageNum", defaultValue = "1")Integer pageNum,
                                      @RequestParam(value = "pageSize", defaultValue = "10")Integer pageSize,
@@ -106,6 +139,10 @@ public class TaBuildingController extends BaseController {
      * @param parameter
      * @return
      */
+    @ApiOperation(value = "更新项目", notes = "更新项目")
+    @ApiImplicitParams({
+
+    })
     @PutMapping("/admin/building/update")
     public ResponseBean buildingUpdate(@RequestBody String parameter, HttpServletRequest request){
         return taBuildingService.buildingUpdate(parameter, getOrgId(request));
@@ -116,6 +153,10 @@ public class TaBuildingController extends BaseController {
      * @param parameter
      * @return
      */
+    @ApiOperation(value = "项目添加", notes = "项目添加")
+    @ApiImplicitParams({
+
+    })
     @RequestMapping(value = "/admin/building/add", method = RequestMethod.POST)
     public ResponseBean buildingAdd(@RequestBody String parameter, HttpServletRequest request){
         return taBuildingService.buildingAdd(parameter, getOrgId(request));
@@ -126,6 +167,10 @@ public class TaBuildingController extends BaseController {
      * @param parameter
      * @return
      */
+    @ApiOperation(value = "项目发布", notes = "项目发布")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "body", name = "parameter", value = "status：状态，id：项目id"),
+    })
     @RequestMapping(value = "/admin/building/update/status", method = RequestMethod.PUT)
     public ResponseBean buildingUpdateStatus(@RequestBody String parameter, HttpServletRequest request){
         return taBuildingService.buildingUpdateStatus(parameter, getOrgId(request));
@@ -137,6 +182,10 @@ public class TaBuildingController extends BaseController {
      * @param request
      * @return
      */
+    @ApiOperation(value = "项目发布", notes = "项目发布")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "path", name = "id", value = "项目id"),
+    })
     @RequestMapping(value = "/admin/building/delete/{id}", method = RequestMethod.DELETE)
     public ResponseBean buildingdelete(@PathVariable("id") String id, HttpServletRequest request){
         return taBuildingService.buildingdelete(id, getOrgId(request));
@@ -148,6 +197,7 @@ public class TaBuildingController extends BaseController {
      * @param session
      * @return
      */
+    @ApiOperation(value = "添加户型", notes = "添加户型")
     @RequestMapping(value = "/admin/buildingApartment/add", method = RequestMethod.POST)
     public ResponseBean buildingApartment(@RequestBody String parameter, HttpSession session){
         return taBuildingService.buildingApartmentAdd(parameter);
@@ -158,16 +208,21 @@ public class TaBuildingController extends BaseController {
      * @param parameter
      * @return
      */
+    @ApiOperation(value = "户型编辑", notes = "户型编辑")
     @RequestMapping(value = "/admin/buildingApartment/update", method = RequestMethod.PUT)
     public ResponseBean buildingApartmentUpdate(@RequestBody String parameter){
         return taBuildingService.buildingApartmentUpdate(parameter);
     }
 
     /**
-     * 楼盘详情
+     * 户型详情
      * @param id
      * @return
      */
+    @ApiOperation(value = "户型详情", notes = "户型详情")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "path", name = "id", value = "户型id"),
+    })
     @RequestMapping(value = "/admin/buildingApartment/{id}", method = RequestMethod.GET)
     public ResponseBean buildingApartmentSelectId(@PathVariable(value = "id") String id){
         return taBuildingService.buildingApartmentSelectId(id);
@@ -178,6 +233,10 @@ public class TaBuildingController extends BaseController {
      * @param id
      * @return
      */
+    @ApiOperation(value = "依据项目ID 查户型", notes = "依据项目ID 查户型")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = String.class, paramType = "path", name = "id", value = "项目ID"),
+    })
     @RequestMapping(value = "/admin/buildingApartment/buildingId/{id}", method = RequestMethod.GET)
     public ResponseBean buildingApartmentBuildingId(@PathVariable(value = "id") String id){
         return taBuildingService.buildingApartmentBuildingId(id);

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

@@ -91,6 +91,11 @@ public class TdBuildingTypeController 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 = "一页多少行")
+    })
     @RequestMapping(value="/wx/tdBuildingType",method= RequestMethod.GET)
     public ResponseBean tdWxBuildingTypeList(@RequestParam(value ="pageNum",defaultValue = "1") Integer pageNum,
                                            @RequestParam(value ="pageSize",defaultValue = "10") Integer pageSize,
@@ -120,6 +125,7 @@ public class TdBuildingTypeController extends BaseController {
      * @param tdBuildingType 实体对象
      * @return
      */
+    @ApiOperation(value = "项目类型保存", notes = "项目类型保存")
     @RequestMapping(value="/admin/tdBuildingType",method= RequestMethod.POST)
     public ResponseBean tdBuildingTypeAdd(@RequestBody TdBuildingType tdBuildingType, HttpServletRequest request){
         ResponseBean responseBean = new ResponseBean();
@@ -141,6 +147,10 @@ public class TdBuildingTypeController extends BaseController {
      * 根据id删除对象
      * @param id  实体ID
      */
+    @ApiOperation(value = "项目类型 根据项目类型id删除", notes = "项目类型删除 根据项目类型id删除")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "id", paramType = "path",value = "项目类型id"),
+    })
     @ResponseBody
     @RequestMapping(value="/admin/tdBuildingType/{id}", method= RequestMethod.DELETE)
     public ResponseBean tdBuildingTypeDelete(@PathVariable Integer id){
@@ -164,6 +174,11 @@ public class TdBuildingTypeController extends BaseController {
      * @param tdBuildingType 实体对象
      * @return
      */
+    @ApiOperation(value = "项目类型 根据项目类型id修改", notes = "项目类型删除 根据项目类型id修改")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "id", paramType = "path",value = "项目类型id"),
+            @ApiImplicitParam(dataTypeClass = TdBuildingType.class, name = "tdBuildingType", paramType = "body",value = "项目类型"),
+    })
     @RequestMapping(value="/admin/tdBuildingType/{id}",method= RequestMethod.PUT)
     public ResponseBean tdBuildingTypeUpdate(@PathVariable Integer id,
                                         @RequestBody TdBuildingType tdBuildingType,
@@ -197,6 +212,10 @@ public class TdBuildingTypeController extends BaseController {
      * 根据id查询对象
      * @param id  实体ID
      */
+    @ApiOperation(value = "项目类型 根据项目类型id查询对象", notes = "项目类型删除 根据项目类型id查询对象")
+    @ApiImplicitParams({
+            @ApiImplicitParam(dataTypeClass = Integer.class, name = "id", paramType = "path",value = "项目类型id"),
+    })
     @RequestMapping(value="/admin/tdBuildingType/{id}",method= RequestMethod.GET)
     public ResponseBean tdBuildingTypeGet(@PathVariable Integer id){
         ResponseBean responseBean = new ResponseBean();