
一步步教你進行 Python REST API 身份驗證
Program.cs
中已注冊 DbContext
、AutoMapper 及各倉儲 AddScoped < …, … >()
項目結構:
/Interfaces
IOwnerRepository.cs
IReviewRepository.cs
IReviewerRepository.cs
…
/Repositories
OwnerRepository.cs
ReviewRepository.cs
ReviewerRepository.cs
…
/DTOs
OwnerDto.cs
ReviewDto.cs
ReviewerDto.cs
/Helpers
MappingProfiles.cs
/Controllers
OwnerController.cs
ReviewController.cs
ReviewerController.cs
/Data
AppDbContext.cs
定義三種方法,滿足關聯查詢與存在性校驗:
public interface IOwnerRepository
{
IReadOnlyCollection < Pokemon > GetPokemonsByOwner(int ownerId); // 獲取某 Owner 的所有 Pokemon
bool OwnerExists(int ownerId); // 判斷 Owner 是否存在
}
在 Repositories/OwnerRepository.cs
中實現:
public class OwnerRepository : IOwnerRepository
{
private readonly AppDbContext _context;
public OwnerRepository(AppDbContext context) = > _context = context;
public IReadOnlyCollection < Pokemon > GetPokemonsByOwner(int ownerId) = >
_context.PokemonOwners
.Where(po = > po.Owner.Id == ownerId) // 過濾關聯表
.Select(po = > po.Pokemon) // 投影到 Pokemon
.ToList();
public bool OwnerExists(int ownerId) = >
_context.Owners.Any(o = > o.Id == ownerId);
}
DTOs/OwnerDto.cs
:
public class OwnerDto
{
public int Id { get; set; }
public string FirstName { get; set; }
public string LastName { get; set; }
}
在 Helpers/MappingProfiles.cs
中添加:
CreateMap < Pokemon, PokemonDto > ();
[ApiController]
[Route("api/[controller]")]
public class OwnerController : ControllerBase
{
private readonly IOwnerRepository _repo;
private readonly IMapper _mapper;
public OwnerController(IOwnerRepository repo, IMapper mapper)
{
_repo = repo;
_mapper = mapper;
}
// GET api/owner/{id}/pokemons
[HttpGet("{id}/pokemons")]
public ActionResult < IReadOnlyCollection < PokemonDto > > GetPokemonsByOwner(int id)
{
if (!_repo.OwnerExists(id))
return NotFound($"Owner {id} 未找到。");
var pokemons = _repo.GetPokemonsByOwner(id);
return Ok(_mapper.Map < IReadOnlyCollection < PokemonDto > > (pokemons));
}
}
public interface IReviewRepository
{
IReadOnlyCollection < Review > GetReviews(); // 全部 Review
Review GetReview(int reviewId); // 單條 Review
IReadOnlyCollection < Review > GetReviewsByPokemon(int pokemonId); // 某 Pokemon 的所有 Review
bool ReviewExists(int reviewId); // Review 存在性校驗
}
public class ReviewRepository : IReviewRepository
{
private readonly AppDbContext _context;
public ReviewRepository(AppDbContext context) = > _context = context;
public IReadOnlyCollection < Review > GetReviews() = >
_context.Reviews.ToList();
public Review GetReview(int reviewId) = >
_context.Reviews.FirstOrDefault(r = > r.Id == reviewId);
public IReadOnlyCollection < Review > GetReviewsByPokemon(int pokemonId) = >
_context.Reviews
.Where(r = > r.Pokemon.Id == pokemonId)
.ToList();
public bool ReviewExists(int reviewId) = >
_context.Reviews.Any(r = > r.Id == reviewId);
}
DTOs/ReviewDto.cs
:
public class ReviewDto
{
public int Id { get; set; }
public string Title { get; set; }
public string Text { get; set; }
public int Rating { get; set; }
}
MappingProfiles
中:
CreateMap < Review, ReviewDto > ();
[ApiController]
[Route("api/[controller]")]
public class ReviewController : ControllerBase
{
private readonly IReviewRepository _repo;
private readonly IMapper _mapper;
public ReviewController(IReviewRepository repo, IMapper mapper)
{
_repo = repo;
_mapper = mapper;
}
// GET api/review
[HttpGet]
public ActionResult < IReadOnlyCollection < ReviewDto > > GetReviews()
= > Ok(_mapper.Map < IReadOnlyCollection < ReviewDto > >(_repo.GetReviews()));
// GET api/review/{id}
[HttpGet("{id}")]
public ActionResult < ReviewDto > GetReview(int id)
{
if (!_repo.ReviewExists(id))
return NotFound($"Review {id} 未找到。");
return Ok(_mapper.Map < ReviewDto > (_repo.GetReview(id)));
}
// GET api/review/pokemon/{pokemonId}
[HttpGet("pokemon/{pokemonId}")]
public ActionResult < IReadOnlyCollection < ReviewDto > > GetReviewsByPokemon(int pokemonId)
{
var reviews = _repo.GetReviewsByPokemon(pokemonId);
return Ok(_mapper.Map < IReadOnlyCollection < ReviewDto > > (reviews));
}
}
public interface IReviewerRepository
{
IReadOnlyCollection < Reviewer > GetReviewers(); // 全部 Reviewer
Reviewer GetReviewer(int reviewerId); // 單條 Reviewer
IReadOnlyCollection < Review > GetReviewsByReviewer(int reviewerId); // 某 Reviewer 的所有 Review
bool ReviewerExists(int reviewerId); // Reviewer 存在性校驗
}
public class ReviewerRepository : IReviewerRepository
{
private readonly AppDbContext _context;
public ReviewerRepository(AppDbContext context) = > _context = context;
public IReadOnlyCollection < Reviewer > GetReviewers() = >
_context.Reviewers.Include(r = > r.Reviews).ToList(); // Include 加載導航屬性
public Reviewer GetReviewer(int id) = >
_context.Reviewers.FirstOrDefault(r = > r.Id == id);
public IReadOnlyCollection < Review > GetReviewsByReviewer(int id) = >
_context.Reviews.Where(r = > r.Reviewer.Id == id).ToList();
public bool ReviewerExists(int id) = >
_context.Reviewers.Any(r = > r.Id == id);
}
DTOs/ReviewerDto.cs
:
public class ReviewerDto
{
public int Id { get; set; }
public string FirstName { get; set; }
public string LastName { get; set; }
}
MappingProfiles
中:
CreateMap < Reviewer, ReviewerDto > ();
[ApiController]
[Route("api/[controller]")]
public class ReviewerController : ControllerBase
{
private readonly IReviewerRepository _repo;
private readonly IMapper _mapper;
public ReviewerController(IReviewerRepository repo, IMapper mapper)
{
_repo = repo;
_mapper = mapper;
}
// GET api/reviewer
[HttpGet]
public ActionResult < IReadOnlyCollection < ReviewerDto > > GetReviewers()
= > Ok(_mapper.Map < IReadOnlyCollection < ReviewerDto > >(_repo.GetReviewers()));
// GET api/reviewer/{id}
[HttpGet("{id}")]
public ActionResult < ReviewerDto > GetReviewer(int id)
{
if (!_repo.ReviewerExists(id))
return NotFound($"Reviewer {id} 未找到。");
return Ok(_mapper.Map < ReviewerDto > (_repo.GetReviewer(id)));
}
// GET api/reviewer/{id}/reviews
[HttpGet("{id}/reviews")]
public ActionResult < IReadOnlyCollection < ReviewDto > > GetReviewsByReviewer(int id)
{
var reviews = _repo.GetReviewsByReviewer(id);
return Ok(_mapper.Map < IReadOnlyCollection < ReviewDto > > (reviews));
}
}
對于多對多或雙向導航屬性,默認序列化會出現循環依賴。解決方法:在 Program.cs
中替換默認 JSON 序列化設置為 ReferenceHandler.IgnoreCycles
:
builder.Services.AddControllers()
.AddJsonOptions(options = >
options.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles);
IRepository
,再分層實現,保證松耦合與可測試性。ReferenceHandler.IgnoreCycles
消除 JSON 循環引用。/resource
、詳情 /resource/{id}
、子資源 /resource/{id}/sub}
。通過本篇,你已完成 Owner、Review、Reviewer 三個模型的 GET 接口搭建,下一步將進入 POST/PUT/DELETE,實現完整的 CRUD 能力。期待與您下次再見!
原文引自YouTube視頻:https://www.youtube.com/watch?v=FEanWuYq7us