🌐 Build REST APIs with Controllers
REST APIs need structure. API Controllers handle HTTP requests. GET, POST, PUT, DELETE — clean and organized.
📝 Basic API Controller
[ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
private readonly IUserService _userService;
public UsersController(IUserService userService)
{
_userService = userService;
}
[HttpGet]
public async Task>> GetUsers()
{
var users = await _userService.GetAllAsync();
return Ok(users);
}
[HttpGet("{id}")]
public async Task> GetUser(int id)
{
var user = await _userService.GetByIdAsync(id);
if (user == null)
return NotFound();
return Ok(user);
}
[HttpPost]
public async Task> CreateUser(User user)
{
var created = await _userService.CreateAsync(user);
return CreatedAtAction(nameof(GetUser), new { id = created.Id }, created);
}
[HttpPut("{id}")]
public async Task UpdateUser(int id, User user)
{
if (id != user.Id)
return BadRequest();
await _userService.UpdateAsync(user);
return NoContent();
}
[HttpDelete("{id}")]
public async Task DeleteUser(int id)
{
await _userService.DeleteAsync(id);
return NoContent();
}
}
🎯 ActionResult Types
// Success
return Ok(data); // 200 OK
return Created(); // 201 Created
return NoContent(); // 204 No Content
// Client errors
return BadRequest(); // 400 Bad Request
return NotFound(); // 404 Not Found
return Unauthorized(); // 401 Unauthorized
return Forbid(); // 403 Forbidden
// Server errors
return StatusCode(500); // 500 Internal Server Error
return Problem(); // 500 with Problem Details
// Validation
if (!ModelState.IsValid)
return BadRequest(ModelState);
💡 Best Practices
- Use [ApiController] attribute
- Route with [Route(“api/[controller]”)]
- Return appropriate status codes
- Validate model state
- Use async methods for I/O
“API Controllers organize REST endpoints. Clean, consistent, easy to maintain. Essential for web APIs.”
