PandaTech.ServiceResponse
2.0.2
dotnet add package PandaTech.ServiceResponse --version 2.0.2
NuGet\Install-Package PandaTech.ServiceResponse -Version 2.0.2
<PackageReference Include="PandaTech.ServiceResponse" Version="2.0.2" />
paket add PandaTech.ServiceResponse --version 2.0.2
#r "nuget: PandaTech.ServiceResponse, 2.0.2"
// Install PandaTech.ServiceResponse as a Cake Addin #addin nuget:?package=PandaTech.ServiceResponse&version=2.0.2 // Install PandaTech.ServiceResponse as a Cake Tool #tool nuget:?package=PandaTech.ServiceResponse&version=2.0.2
ServiceResponse
Intro
This is service response template for .Net 6+ web api projects. This template is based on the best practices and has goal to harmonize all API I/O operations. The benefit of this template over other templates is that it totally integrates with OpenAPI and Swagger. So, IActionResults and other services, response will be visible in Swagger UI and loads of other features are and is going to be included.
This Template is designed by PandaTech LLC. We build software with the greatest quality! Our website: www.pandatech.it 😃
Example
Model
public class Blog
{
public int BlogId { get; set; }
public string BlogName { get; set; }
public string BlogDescription { get; set; }
}
public class Post
{
public int PostId { get; set; }
public string PostName { get; set; }
public string PostDescription { get; set; }
public int BlogId { get; set; }
}
Program.cs extract
builder.Services.AddTransient<IService, Services>();
#if DEBUG
builder.Services.AddTransient<IExceptionHandler, DebugExceptionHandler>();
#else
builder.Services.AddTransient<IExceptionHandler, PublicExceptionHandler>();
#endif
Service
public class Services : IService
{
public ServiceResponse DeletePost(int postId)
{
var serviceResponse = new ServiceResponse();
if (postId == 0) // just for example, cannot be in real case
{
serviceResponse.ResponseStatus = ServiceResponseStatus.NotFound;
serviceResponse.Message = $"Post with id {postId} not found";
serviceResponse.Success = false;
}
else
{
serviceResponse.Message = $"Post with id {postId} deleted";
serviceResponse.ResponseStatus = ServiceResponseStatus.Ok;
}
return serviceResponse;
}
public ServiceResponse<Post> GetPost(int postId)
{
var serviceResponse = new ServiceResponse<Post>();
serviceResponse.Data = new Post
{
PostId = postId,
PostName = "Your post name",
PostDescription = "Post Description",
};
return serviceResponse;
}
public ServiceResponsePaged<List<Blog>> GetAllBlogs(int page, int pageSize)
{
var serviceResponse = new ServiceResponsePaged<List<Blog>>();
serviceResponse.Page = page;
serviceResponse.PageSize = pageSize;
serviceResponse.TotalCount = 1; // just for example
serviceResponse.Data = new List<Blog>
{
new Blog
{
BlogId = 1,
BlogName = "Your blog name",
BlogDescription = "Blog Description",
}
};
return serviceResponse;
}
}
Controller
[ApiController]
[Route("[controller]")]
public class DemoController : ExtendedController
{
private IService _service;
public DemoController(IExceptionHandler exceptionHandler, IService service) : base(exceptionHandler)
{
_service = service;
}
[HttpDelete("Post")]
public ServiceResponse DeletePost(int postId)
{
try
{
return _service.DeletePost(postId);
}
catch (Exception e)
{
return ExceptionHandler.Handle(new ServiceResponse(), e);
}
}
[HttpGet("Post")]
public ServiceResponse<Post> GetPost(int postId)
{
try
{
return _service.GetPost(int postId);
}
catch (Exception e)
{
return ExceptionHandler.Handle(new ServiceResponse<Post>(), e);
}
}
[HttpGet("Blogs")]
public ServiceResponsePaged<List<Blog>> GetAllBlogs(int page, int pageSize)
{
try
{
return _service.GetAllBlogs(page,pageSize);
}
catch (Exception e)
{
return ExceptionHandler.Handle(new ServiceResponsePaged<Blog>(), e);
}
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net9.0 is compatible. |
-
net9.0
- Microsoft.AspNetCore.OpenApi (>= 9.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.0.2 | 147 | 11/23/2024 |
2.0.1 | 85 | 11/23/2024 |
2.0.0 | 119 | 11/21/2024 |
1.2.10 | 156 | 10/20/2023 |
1.2.9 | 152 | 10/20/2023 |
1.2.8 | 215 | 9/11/2023 |
1.2.7 | 146 | 9/6/2023 |
1.2.6 | 182 | 8/14/2023 |
1.2.5 | 196 | 8/14/2023 |
1.2.4 | 155 | 8/14/2023 |
1.2.3 | 150 | 8/9/2023 |
1.2.2 | 168 | 7/20/2023 |
1.2.1 | 194 | 6/13/2023 |
1.1.9 | 182 | 6/6/2023 |
1.1.8 | 165 | 6/2/2023 |
1.1.7 | 136 | 6/2/2023 |
1.1.6 | 131 | 6/2/2023 |
1.1.5 | 149 | 5/26/2023 |
1.1.4 | 357 | 4/5/2023 |
1.1.3 | 273 | 3/18/2023 |
1.1.2 | 217 | 3/17/2023 |
1.1.1 | 242 | 3/17/2023 |
1.1.0 | 226 | 3/16/2023 |
1.0.0 | 238 | 2/14/2023 |
.net 9 update with namespace breaking changes