feat: add an extension to simplify attributes
This commit is contained in:
parent
bc99007d94
commit
a4dfccbc22
@ -0,0 +1,8 @@
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using System;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
|
||||
namespace Mirea.Api.Endpoint.Common.Extensions;
|
||||
|
||||
[AttributeUsage(AttributeTargets.Method, Inherited = false, AllowMultiple = true)]
|
||||
public class BadRequestResponseAttribute() : ProducesResponseTypeAttribute(typeof(ErrorResponseVm), StatusCodes.Status400BadRequest);
|
18
Endpoint/Common/Extensions/ErrorResponseVm.cs
Normal file
18
Endpoint/Common/Extensions/ErrorResponseVm.cs
Normal file
@ -0,0 +1,18 @@
|
||||
namespace Mirea.Api.Endpoint.Common.Extensions;
|
||||
|
||||
/// <summary>
|
||||
/// A class for providing information about an error
|
||||
/// </summary>
|
||||
public class ErrorResponseVm
|
||||
{
|
||||
/// <summary>
|
||||
/// The text or translation code of the error. This field may not contain information in specific scenarios.
|
||||
/// For example, it might be empty for HTTP 204 responses where no content is returned or if the validation texts have not been configured.
|
||||
/// </summary>
|
||||
public required string Error { get; set; }
|
||||
/// <summary>
|
||||
/// In addition to returning the response code in the header, it is also duplicated in this field.
|
||||
/// Represents the HTTP response code.
|
||||
/// </summary>
|
||||
public required int Code { get; set; }
|
||||
}
|
8
Endpoint/Common/Extensions/NotFoundResponseAttribute.cs
Normal file
8
Endpoint/Common/Extensions/NotFoundResponseAttribute.cs
Normal file
@ -0,0 +1,8 @@
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using System;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
|
||||
namespace Mirea.Api.Endpoint.Common.Extensions;
|
||||
|
||||
[AttributeUsage(AttributeTargets.Method, Inherited = false, AllowMultiple = true)]
|
||||
public class NotFoundResponseAttribute() : ProducesResponseTypeAttribute(typeof(ErrorResponseVm), StatusCodes.Status404NotFound);
|
Loading…
Reference in New Issue
Block a user