使用ASP.NET Core 3.x 构建 RESTful API P21 创建资源

新建模板

博客园文章Id:

根据经验,我们在做查询,创建,更新时,我们应该使用不同的Dto类,虽然绝大多数时候,可能他们的成员是一样的,但是业务是变化的,创建不同的Dto类的好处,在于可以快速的方便我们对于某一块业务进行重构.

下面我们开始编写用于创建公司资源的API

[HttpPost]
public async Task<ActionResult<CompanyDto>> CreateCompany([FromBody]CompanyAddDto company)
{
            //当请求的Body转换成CompanyAddDto失败时,company就会为null,(在.Net Core 3.x之前,
            //因为早期版本是没有ApiController这个特性的)所以我们在此处应该判断一下,
            //但是在.Net Core 3.x (添加[ApiController特性])之后,当请求的Body转换失败之后,.Net Core 3.x 会自动返回 400 状态码,所以下面的if判断可以不写.
            if (company == null)
            {
                return BadRequest();
            }

            var entity = this._mapper.Map<Company>(company);

            this._companyRepository.AddCompany(entity);

            await this._companyRepository.SaveAsync();

            //POST请求成功之后之后,我们应该返回201状态码

            var returnDto = this._mapper.Map<CompanyDto>(entity);

            //返回插入的资源
            //第一个参数:返回可找到当前资源的URI
            //第二个参数:路由的值
            //第三个参数:返回的是响应的Body
            return CreatedAtRoute(
                nameof(GetCompany),
                new{companyId = returnDto.Id},
                returnDto);
}

在上述代码中,CreatedAtRoute方法的第一个参数,是返回可以查询到当前创建的资源的URI指向的Action方法,所以我们需要给该方法起一个名称代码如下:

 /// <summary>
 /// 获取指定公司
 /// </summary>
 /// <param name="companyId">公司id</param>
 /// <returns></returns>
 [HttpGet("{companyId}",Name =nameof(GetCompany) )]  //注意此处的Name属性
 //[Route("{companyId}")]   //使用这种方式也能表示路由,但是不常用
 public async Task<ActionResult<Company>> GetCompany(Guid companyId)

创建用于添加公司资源的Dto对象的代码如下:

 /// <summary>
 /// 创建公司的Dto对象
 /// </summary>
 public class CompanyAddDto
 {
     
     public string Name { get; set; }
     public string Introduction { get; set; }

 }

在CompanyProfile.cs类中,映射 CompanyAddDto 与表示实体 Comapny 的映射关系,代码如下:

/*
 * CompanyAddDto(原对象),Company(目标对象)的映射
 */
CreateMap<CompanyAddDto,Company>();

优化实现类添加公司部分的代码:

public void AddCompany(Company company)
{
    if (company == null)
    {
        throw new ArgumentException(nameof(company));
    }

    company.Id = Guid.NewGuid();

    if (company.Employees !=null)
    {
        foreach (var employee in company.Employees)
        {
            employee.Id = Guid.NewGuid();
        }

    }

    this._content.Add(company);
    //this._content.Companies.AddAsync(company);
}

调用创建公司资源接口: