company添加swagger注解

zlpt-modules/zlpt-company/src/main/java/com/bonus/zlpt/company/controller/BaseAddressController.java

@@ -4,16 +4,20 @@ import com.bonus.zlpt.common.core.web.controller.BaseController;
 import com.bonus.zlpt.common.core.web.domain.AjaxResult;
 import com.bonus.zlpt.company.api.domain.BaseAddress;
 import com.bonus.zlpt.company.service.BaseAddressService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
 
 @RestController
 @RequestMapping("/baseAddress")
+@Api(value = "企业地址管理",tags = {"企业地址模块"})
 public class BaseAddressController extends BaseController {
 
     @Autowired
     private BaseAddressService baseAddressService;
 
+    @ApiOperation("查询地址")
     @PostMapping("/selectAddress")
     public AjaxResult selectAddress(@RequestBody BaseAddress baseAddress){
 

zlpt-modules/zlpt-company/src/main/java/com/bonus/zlpt/company/controller/BmCoBankController.java

@@ -1,6 +1,8 @@
 package com.bonus.zlpt.company.controller;
 import com.bonus.zlpt.company.api.domain.BmCoBank;
 import com.bonus.zlpt.company.service.impl.BmCoBankServiceImpl;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.*;
 
 import javax.annotation.Resource;
@@ -12,6 +14,7 @@ import javax.annotation.Resource;
 */
 @RestController
 @RequestMapping("/company_bank")
+@Api(value = "企业开户行信息",tags = {"企业开户行信息"})
 public class BmCoBankController {
 
     /**
@@ -27,12 +30,14 @@ public class BmCoBankController {
     * @return 单条数据
     */
     @GetMapping("selectOne")
+    @ApiOperation("通过主键查询单条数据")
     public BmCoBank selectOne(Integer id) {
     return bmCoBankServiceImpl.selectByPrimaryKey(id);
     }
 
 
     @PostMapping("insert")
+    @ApiOperation("新增企业开户行信息")
     public int insert(@RequestBody BmCoBank bmCoBank){
         return bmCoBankServiceImpl.insert(bmCoBank);
     }

zlpt-modules/zlpt-company/src/main/java/com/bonus/zlpt/company/controller/BmCompanyInfoController.java

@@ -14,6 +14,8 @@ import com.bonus.zlpt.company.api.domain.vo.BmCompanyInfoVo;
 import com.bonus.zlpt.company.mapper.BmCompanyInfoDao;
 import com.bonus.zlpt.company.service.BmCompanyInfoService;
 import com.bonus.zlpt.common.log.annotation.Log;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.*;
 import javax.annotation.Resource;
 import javax.servlet.http.HttpServletResponse;
@@ -27,6 +29,7 @@ import java.util.List;
 */
 @RestController
 @RequestMapping("/company_info")
+@Api(value = "企业信息管理",tags = {"企业信息表"})
 public class BmCompanyInfoController extends BaseController {
 
     @Resource
@@ -42,6 +45,7 @@ public class BmCompanyInfoController extends BaseController {
     * @return 单条数据
     */
     @GetMapping("selectById")
+    @ApiOperation("通过主键查询单条数据")
     public BmCompanyInfo selectById(Integer id) { return bmCompanyInfoService.selectByPrimaryKey(id); }
 
 
@@ -50,6 +54,7 @@ public class BmCompanyInfoController extends BaseController {
      */
     @RequiresPermissions("system:company:list")
     @GetMapping("/list")
+    @ApiOperation("获取公司列表")
     public AjaxResult list(BmCompanyInfo obj) {
         List<BmCompanyInfo> list = bmCompanyInfoDao.selectCompanyList(obj);
         return success(list);
@@ -61,6 +66,7 @@ public class BmCompanyInfoController extends BaseController {
     @RequiresPermissions("system:company:add")
     @Log(title = "企业管理", businessType = BusinessType.INSERT)
     @PostMapping("addCompanyInfo")
+    @ApiOperation("录入企业信息")
     public AjaxResult add(@RequestBody BmCompanyInfoDto obj) {
         return toAjax(bmCompanyInfoService.insertSelective(obj));
     }
@@ -71,6 +77,7 @@ public class BmCompanyInfoController extends BaseController {
     @RequiresPermissions("system:company:edit")
     @Log(title = "企业管理", businessType = BusinessType.UPDATE)
     @PostMapping("updateCompanyInfo")
+    @ApiOperation("企业信息变更")
     public AjaxResult edit(@RequestBody BmCompanyInfoDto obj) {
 
         Integer deptId = obj.getBmCompanyInfo().getCompanyId();
@@ -88,6 +95,7 @@ public class BmCompanyInfoController extends BaseController {
     @RequiresPermissions("system:company:remove")
     @Log(title = "企业管理", businessType = BusinessType.DELETE)
     @DeleteMapping("/{deptId}")
+    @ApiOperation("企业注销")
     public AjaxResult remove(@PathVariable Integer deptId) {
         return toAjax(bmCompanyInfoService.deleteByPrimaryKey(deptId));
     }
@@ -97,6 +105,7 @@ public class BmCompanyInfoController extends BaseController {
      * 根据条件查询企业信息(企业入驻审核)
      */
     @PostMapping("/selectList")
+    @ApiOperation("根据条件查询企业信息(企业入驻审核)")
     public TableDataInfo selectList(@RequestBody BmCompanyDto bmCompanyDto){
 
         startPage(bmCompanyDto.getPageNum(), bmCompanyDto.getPageSize());
@@ -110,6 +119,7 @@ public class BmCompanyInfoController extends BaseController {
      * @return
      */
     @GetMapping("/getCompanyInfoById/{id}")
+    @ApiOperation("根据企业id查询企业信息")
     public AjaxResult getCompanyInfoById(@PathVariable("id") Integer id){
 
         return success(bmCompanyInfoService.getCompanyInfoById(id));
@@ -120,6 +130,7 @@ public class BmCompanyInfoController extends BaseController {
      * @param response
      */
     @GetMapping("/exportExcel")
+    @ApiOperation("企业入驻信息导出")
     public void exportExcel(HttpServletResponse response) throws UnsupportedEncodingException {
 
         ExcelUtil<BmCompanyInfo> bmCompanyInfoExcelUtil = new ExcelUtil<>(BmCompanyInfo.class);
@@ -132,6 +143,7 @@ public class BmCompanyInfoController extends BaseController {
      * @return
      */
     @PostMapping("/selectCompanyInfo")
+    @ApiOperation("根据条件查询企业详细信息")
     public TableDataInfo selectCompanyInfo(@RequestBody BmCompanyDto bmCompanyDto){
 
         startPage(bmCompanyDto.getPageNum(), bmCompanyDto.getPageSize());

zlpt-modules/zlpt-company/src/main/java/com/bonus/zlpt/company/controller/BmCompanyTypeController.java

@@ -8,6 +8,8 @@ import com.bonus.zlpt.common.security.utils.SecurityUtils;
 import com.bonus.zlpt.company.api.domain.SysDic;
 import com.bonus.zlpt.company.mapper.BmCompanyInfoDao;
 import com.bonus.zlpt.company.service.BmCompanyTypeService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
@@ -22,6 +24,7 @@ import java.util.List;
  */
 @RestController
 @RequestMapping("company_type")
+@Api(value = "企业类型管理",tags = {"企业类型管理"})
 public class BmCompanyTypeController extends BaseController {
 
 
@@ -37,6 +40,7 @@ public class BmCompanyTypeController extends BaseController {
      * @return
      */
     @PostMapping("/selectCompanyTypeList")
+    @ApiOperation("根据条件查询企业类型数据")
     public TableDataInfo selectCompanyTypeList(@RequestBody SysDic sysDic){
 
         startPage(sysDic.getPageNum(),sysDic.getPageSize());
@@ -51,6 +55,7 @@ public class BmCompanyTypeController extends BaseController {
      * @return
      */
     @PostMapping("/selectCompanyLtd")
+    @ApiOperation("根据条件查询企业所属")
     public TableDataInfo selectCompanyLtd(@RequestBody SysDic sysDic){
 
         startPage(sysDic.getPageNum(),sysDic.getPageSize());
@@ -65,6 +70,7 @@ public class BmCompanyTypeController extends BaseController {
      * @return
      */
     @PostMapping("/selectIdCard")
+    @ApiOperation("根据条件查询证件类型")
     public TableDataInfo selectIdCard(@RequestBody SysDic sysDic){
 
         startPage(sysDic.getPageNum(),sysDic.getPageSize());
@@ -80,6 +86,7 @@ public class BmCompanyTypeController extends BaseController {
      * @return
      */
     @PostMapping("/addOrUpdateCompanyType")
+    @ApiOperation("新增或者修改企业类型")
     public AjaxResult addOrUpdateCompanyType(@Validated @RequestBody SysDic sysDic ){
 
         //修改
@@ -110,6 +117,7 @@ public class BmCompanyTypeController extends BaseController {
      * @return
      */
     @DeleteMapping("/deleteCompanyType/{id}")
+    @ApiOperation("根据id删除企业类型")
     public AjaxResult deleteCompanyType(@PathVariable("id") Integer id){
 
         //根据id查询企业类型数据
@@ -130,6 +138,7 @@ public class BmCompanyTypeController extends BaseController {
      * @param response
      */
     @GetMapping("/exportExcel")
+    @ApiOperation("企业类型导出")
     public void exportExcel(HttpServletResponse response) throws UnsupportedEncodingException {
 
         ExcelUtil<SysDic> sysDicExcelUtil = new ExcelUtil<>(SysDic.class);

zlpt-modules/zlpt-company/src/main/java/com/bonus/zlpt/company/controller/BusinessMenuController.java

@@ -5,6 +5,8 @@ import com.bonus.zlpt.common.core.web.page.PageDomain;
 import com.bonus.zlpt.common.core.web.page.TableDataInfo;
 import com.bonus.zlpt.company.api.domain.BusinessMenu;
 import com.bonus.zlpt.company.service.BusinessMenuService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
 
@@ -15,6 +17,7 @@ import java.util.List;
  */
 @RestController
 @RequestMapping("/business/menu")
+@Api(value = "业务类型",tags = {"业务类型"})
 public class BusinessMenuController extends BaseController {
 
     @Autowired
@@ -26,6 +29,7 @@ public class BusinessMenuController extends BaseController {
      * @return
      */
     @PostMapping("/selectList")
+    @ApiOperation("查询所有业务类型")
     public TableDataInfo selectList(@RequestBody PageDomain pageDomain){
 
         startPage(pageDomain.getPageNum(), pageDomain.getPageSize());

zlpt-modules/zlpt-company/src/main/java/com/bonus/zlpt/company/controller/BusinessOpenController.java

@@ -9,6 +9,8 @@ import com.bonus.zlpt.company.api.domain.BusinessOpen;
 import com.bonus.zlpt.company.api.domain.dto.BmCompanyDto;
 import com.bonus.zlpt.company.api.domain.vo.BusinessOpenVo;
 import com.bonus.zlpt.company.service.BusinessOpenService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
 
@@ -23,6 +25,7 @@ import java.util.List;
  */
 @RestController
 @RequestMapping("/business/open")
+@Api(value = "企业业务开通管理",tags = {"企业业务开通管理"})
 public class BusinessOpenController extends BaseController {
 
     @Autowired
@@ -35,6 +38,7 @@ public class BusinessOpenController extends BaseController {
      * @return
      */
     @PostMapping("/selectList")
+    @ApiOperation("根据条件查询企业业务开通信息列表")
     public TableDataInfo selectList(@RequestBody BmCompanyDto bmCompanyDto){
 
         startPage(bmCompanyDto.getPageNum(),bmCompanyDto.getPageSize());
@@ -48,6 +52,7 @@ public class BusinessOpenController extends BaseController {
      * @return
      */
     @PostMapping("/insert")
+    @ApiOperation("新增业务开通请求")
     public AjaxResult insertBusinessOpenInfo(@RequestBody BusinessOpen businessOpen){
 
         return toAjax(businessOpenService.insertBusinessOpenInfo(businessOpen));
@@ -59,6 +64,7 @@ public class BusinessOpenController extends BaseController {
      * @return
      */
     @PostMapping("/updateBusiness")
+    @ApiOperation("企业业务开通数据修改")
     public AjaxResult updateBusiness(@RequestBody BusinessOpen businessOpen){
 
         if(!"0".equals(businessOpen.getStatus()) && !"3".equals(businessOpen.getStatus())){
@@ -74,6 +80,7 @@ public class BusinessOpenController extends BaseController {
      * @param response
      */
     @GetMapping("/exportExcel")
+    @ApiOperation("企业业务开通数据导出")
     public void exportExcel(HttpServletResponse response) throws UnsupportedEncodingException {
 
         ExcelUtil<BusinessOpenVo> businessOpenVoExcelUtil = new ExcelUtil<>(BusinessOpenVo.class);

zlpt-modules/zlpt-company/src/main/java/com/bonus/zlpt/company/controller/MaUserCollectController.java

@@ -7,6 +7,8 @@ import com.bonus.zlpt.common.security.annotation.RequiresPermissions;
 import com.bonus.zlpt.company.api.domain.MaUserCollect;
 import com.bonus.zlpt.company.mapper.MaUserCollectMapper;
 import com.bonus.zlpt.company.service.MaUserCollectService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.*;
 
 import javax.annotation.Resource;
@@ -19,6 +21,7 @@ import java.util.List;
 */
 @RestController
 @RequestMapping("/user_collect")
+@Api(value = "城市控制器",tags = {"城市管理"})
 public class MaUserCollectController extends BaseController {
 
     /**
@@ -36,6 +39,7 @@ public class MaUserCollectController extends BaseController {
     @RequiresPermissions("system:collect:add")
     @Log(title = "收藏设备", businessType = BusinessType.INSERT)
     @PostMapping("saveCollectedEquipment")
+    @ApiOperation("新增 -- 收藏设备")
     public AjaxResult saveCollectedEquipment(@RequestBody MaUserCollect obj) {
         try {
             return toAjax(maUserCollectService.insertSelective(obj));
@@ -49,6 +53,7 @@ public class MaUserCollectController extends BaseController {
      */
     @RequiresPermissions("system:collect:list")
     @GetMapping("/getColletList")
+    @ApiOperation("获取收藏列表")
     public AjaxResult getColletList(MaUserCollect obj) {
         try {
             List<MaUserCollect> list = maUserCollectMapper.selectAll(obj);
@@ -64,6 +69,7 @@ public class MaUserCollectController extends BaseController {
     @RequiresPermissions("system:collect:remove")
     @Log(title = "取消收藏", businessType = BusinessType.DELETE)
     @PostMapping("cancelCollet")
+    @ApiOperation("删除 -- 取消收藏")
     public AjaxResult cancelCollet(@RequestBody MaUserCollect obj) {
         try {
             return toAjax(maUserCollectService.deleteByPrimaryKey(obj));
@@ -79,6 +85,7 @@ public class MaUserCollectController extends BaseController {
     @RequiresPermissions("system:collect:list")
     @Log(title = "根据设备id查询信息", businessType = BusinessType.OTHER)
     @GetMapping("selectByMaId")
+    @ApiOperation("查询 -- 根据设备id获取信息")
     public AjaxResult selectByMaId(Integer maId) {
         try {
             return success(maUserCollectService.selectByMaId(maId));
@@ -95,6 +102,7 @@ public class MaUserCollectController extends BaseController {
     * @return 单条数据
     */
     @GetMapping("selectOne")
+    @ApiOperation("通过主键查询单条数据")
     public MaUserCollect selectOne(Integer id) {
     return maUserCollectService.selectByPrimaryKey(id);
     }

zlpt-modules/zlpt-company/src/main/java/com/bonus/zlpt/company/controller/ServiceGreementInfoController.java

@@ -9,6 +9,8 @@ import com.bonus.zlpt.company.api.domain.ServiceGreementInfo;
 import com.bonus.zlpt.company.api.domain.dto.ServiceDto;
 import com.bonus.zlpt.company.api.domain.vo.ServiceGreementVo;
 import com.bonus.zlpt.company.service.ServiceGreementInfoService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.web.bind.annotation.*;
 
 import javax.annotation.Resource;
@@ -24,6 +26,7 @@ import java.util.List;
  */
 @RestController
 @RequestMapping("serviceGreementInfo")
+@Api(value = "隐私服务协议表",tags = {"隐私服务协议管理"})
 public class ServiceGreementInfoController extends BaseController {
     /**
      * 服务对象
@@ -37,6 +40,7 @@ public class ServiceGreementInfoController extends BaseController {
      * @return
      */
     @PostMapping("/list")
+    @ApiOperation("获取隐私协议模板列表")
     public TableDataInfo getPrivacyAgreementTemplateList(@RequestBody ServiceDto dto)
     {
         startPage(dto.getPageNum(), dto.getPageSize());
@@ -50,6 +54,7 @@ public class ServiceGreementInfoController extends BaseController {
      * @return
      */
     @GetMapping("/{id}")
+    @ApiOperation("根据id查询隐私协议模板信息")
     public AjaxResult getListById(@PathVariable("id") int id)
     {
         ServiceGreementVo serviceGreementVo = serviceGreementInfoService.selectListById(id);
@@ -62,6 +67,7 @@ public class ServiceGreementInfoController extends BaseController {
      * @return
      */
     @PostMapping("/add")
+    @ApiOperation("新增隐私协议模板信息")
     public AjaxResult addPrivacyAgreementTemplateList(@RequestBody ServiceGreementInfo dto)
     {
         Long userId = SecurityUtils.getUserId();
@@ -75,6 +81,7 @@ public class ServiceGreementInfoController extends BaseController {
      * @param
      */
     @GetMapping("/export")
+    @ApiOperation("导出隐私协议模板信息")
     public void expPrivacyAgreementTemplate(HttpServletResponse response) throws UnsupportedEncodingException {
         ExcelUtil<ServiceGreementVo> util = new ExcelUtil<>(ServiceGreementVo.class);
         util.exportExcel(response, serviceGreementInfoService.selectGreementInfoList(new ServiceDto()), "隐私协议模板信息", "","隐私协议模板信息");
@@ -86,6 +93,7 @@ public class ServiceGreementInfoController extends BaseController {
      * @return
      */
     @PutMapping("/update")
+    @ApiOperation("编辑隐私协议模板信息")
     public AjaxResult updatePrivacyAgreementTemplateList(@RequestBody ServiceGreementInfo dto)
     {
         return toAjax(serviceGreementInfoService.update(dto));
@@ -97,6 +105,7 @@ public class ServiceGreementInfoController extends BaseController {
      * @return
      */
     @DeleteMapping("/{id}")
+    @ApiOperation("根据id删除隐私协议模板")
     public AjaxResult delCarouselChartInfo(@PathVariable("id") int id)
     {
         serviceGreementInfoService.delete(id);

zlpt-modules/zlpt-company/src/main/java/com/bonus/zlpt/company/controller/SunAccountController.java

@@ -5,12 +5,15 @@ import com.bonus.zlpt.common.core.web.domain.AjaxResult;
 import com.bonus.zlpt.common.security.utils.SecurityUtils;
 import com.bonus.zlpt.system.api.RemoteUserService;
 import com.bonus.zlpt.system.api.domain.SysUser;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
 import java.util.List;
 
 @RestController
-    @RequestMapping("/sun")
+@RequestMapping("/sun")
+@Api(value = "子账号",tags = {"子账号管理"})
 public class SunAccountController extends BaseController {
 
     @Autowired
@@ -22,6 +25,7 @@ public class SunAccountController extends BaseController {
      * @return
      */
     @GetMapping("/selectUserList")
+    @ApiOperation("获取此账号下的子账号信息")
     public List<SysUser> selectUserList() {
         SysUser sysUser = new SysUser();
         int parentId = Math.toIntExact(SecurityUtils.getUserId());
@@ -36,6 +40,7 @@ public class SunAccountController extends BaseController {
      * @return
      */
     @PostMapping("/sunAdd")
+    @ApiOperation("添加子账号")
     public AjaxResult sunAdd(@RequestBody SysUser sysUser) {
 
         int parentId = Math.toIntExact(SecurityUtils.getUserId());
@@ -51,6 +56,7 @@ public class SunAccountController extends BaseController {
      * @return
      */
     @PostMapping("/updateUserStatus")
+    @ApiOperation("修改子账号状态")
     public AjaxResult updateUserStatus(@RequestBody SysUser sysUser) {
 
         remoteUserService.edit(sysUser);
@@ -63,6 +69,7 @@ public class SunAccountController extends BaseController {
      * @return
      */
     @PostMapping("/deleteUserById/{id}")
+    @ApiOperation("删除子账号")
     public AjaxResult deleteUserById(@PathVariable Long id) {
 
         remoteUserService.remove(new Long[]{id});