基础用户信息 #

功能介绍 #

Mall3s获取主要通过nuget包封装(Mall3s.Server.SDK),可以获取公共用户、岗位、角色、部门、公司、站内信等各个基础服务。

备注:本地调试请启动Mall3s.Server项目,否则本地无法启动。

  • 功能清单
 public interface IHttpSystemApi : IHttpApi
    {
        /// <summary>
        /// 根据字典类型代码获取字典list集合内容
        /// </summary>
        /// <param name="enCode">流程编码</param>
        /// <returns></returns>
        [HttpGet("api/system/dictionarydata/{dictionaryTypeCode}/Data/SelectorByCode")]
        Task<RESTfulResult<DictionaryDataSelectorDataListOutput>> GetSelectorDictioaryData(string dictionaryTypeCode);



        /// <summary>
        /// 发送全平台渠道消息(1站内信,2邮件,3短信,4钉钉,5企业微信)
        /// </summary>
        /// <param name="body">实体对象</param>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpPost("api/notice/SendMessage")]
        Task<RESTfulResult<object>> SendMessageAsync([JsonContent] SysNoticeInput body, CancellationToken cancellationToken = default);



        /// <summary>
        /// 获取系统配置
        /// </summary>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/system/sysconfig")]
        ITask<RESTfulResult<SysConfigOutput>> SysconfigAsync(CancellationToken cancellationToken = default);





        //GET /api/permission/users获取列表(角色EnCode)

        /// <summary>
        /// 根据用户id获取用户信息
        /// </summary>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/permission/users/UserListByRoleEnCode")]
        ITask<RESTfulResult<List<UserInfoOutput>>> GetUserListByRoleAsync(string roleEnCode, CancellationToken cancellationToken = default);


        /// <summary>
        /// 根据用户id获取用户信息
        /// </summary>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpPost("api/permission/users/UserListById")]
        ITask<RESTfulResult<List<UserInfoOutput>>> GetUserListAsync([JsonContent] string userIds, CancellationToken cancellationToken = default);


        //获取公司集合
        /// <summary>
        /// 查询公司列表
        /// </summary>
        /// <param name="keyword">名称,id,encode,parentId都可以查询</param>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/permission/organize")]
        ITask<RESTfulResult<OrganizeListTreeOutput>> SearchOrganizeAsync([PathQuery] KeywordInput input, CancellationToken cancellationToken = default);
        /// <summary>
        /// 获取公司信息
        /// </summary>
        /// <param name="id"></param>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/permission/organize/{id}")]
        ITask<RESTfulResult<OrganizeInfoOutput>> GetOrganizeAsync([Required] string id, CancellationToken cancellationToken = default);


        /// <summary>
        /// 获取下拉框(类型+角色)
        /// </summary>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/permission/role/Selector")]
        ITask<RESTfulResult<RoleListTreeOutput>> RoleSelectorAsync(CancellationToken cancellationToken = default);





        /// <summary>
        /// 获取岗位下拉框(公司+部门+岗位)
        /// </summary>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/permission/position/Selector")]
        ITask<RESTfulResult<PositionListTreeOutput>> PositionSelectorAsync(CancellationToken cancellationToken = default);



        /// <summary>
        /// 获取岗位下拉框(公司+部门+岗位)
        /// </summary>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/permission/position/All")]
        ITask<RESTfulResult<PositionListTreeOutput>> GetAllPositionsAsync(CancellationToken cancellationToken = default);




        /// <summary>
        /// 获取部门信息
        /// </summary>
        /// <param name="companyId">公司主键</param>
        /// <param name="keyword"></param>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/permission/organize/{companyId}/Department")]
        ITask<RESTfulResult<DepartmentListTreeOutput>> SearchDepartmentAsync([Required] string companyId, string keyword, CancellationToken cancellationToken = default);

        /// <summary>
        /// 获取部门下拉框
        /// </summary>
        /// <param name="id"></param>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/permission/organize/Department/Selector/{id}")]
        ITask<RESTfulResult<DepartmentListTreeOutput>> DepartmentSelectorAsync([Required] string id, CancellationToken cancellationToken = default);

        /// <summary>
        /// 根据Id获取部门信息
        /// </summary>
        /// <param name="id">主键</param>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/permission/organize/Department/{id}")]
        ITask<RESTfulResult<DepartmentInfoOutput>> GetDepartmentAsync([Required] string id, CancellationToken cancellationToken = default);

        /// <summary>
        /// 根据Id获取角色信息
        /// </summary>
        /// <param name="id">主键</param>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/permission/role/{id}")]
        ITask<RESTfulResult<RoleInfoOutput>> GetRoleAsync([Required] string id, CancellationToken cancellationToken = default);

        /// <summary>
        /// 搜索角色
        /// </summary>
        /// <param name="keyword">名称,encode都可以查询</param>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/permission/role")]
        ITask<RESTfulResult<RoleListTreeOutput>> SearchRolesAsync([PathQuery] KeywordInput input, CancellationToken cancellationToken = default);

        /// <summary>
        /// 根据Id获取角色信息
        /// </summary>
        /// <param name="id">主键</param>
        /// <param name="cancellationToken">cancellationToken</param>
        /// <returns>Success</returns>
        [HttpGet("api/permission/position/{id}")]
        ITask<RESTfulResult<PositionInfoOutput>> GetPositionAsync([Required] string id, CancellationToken cancellationToken = default);

使用说明 #

  1. 引用nuget包Mal3s.Server.SDK
  2. 配置文件appsettings.json中NacosConfig节点的Listeners添加配置
{
        "Optional": false,
        "DataId": "netcore-webapi.json",
        "Group": "DEFAULT_GROUP"
},
  1. 微服务配置
  services.AddServerApiService(_configuration);
  1. 注入服务
private readonly IHttpSystemApi _httpSystemApi;
 public HomeController(IHttpSystemApi api)
{
  _httpSystemApi = api;
}
  1. 调用基础服务方法
  var userInfos = await _httpSystemApi.GetUserListAsync(ids);
  
  return userInfos;
上次更新: 3/10/2023, 5:33:48 PM