Quy ước Thiết kế API
Nguyên tắc Thiết kế API
Giữ mức độ chi tiết và số lượng endpoint hợp lý
Tên gọi đơn giản, dễ hiểu và nhất quán
Ưu tiên thiết kế trước khi triển khai mã
Thiết kế URL
Phương thức HTTP
GET: Đọc dữ liệu
POST: Tạo mới tài nguyên
PUT: Cập nhật toàn bộ
PATCH: Cập nhật một phần
DELETE: Xóa tài nguyên
Quy tắc Đặt tên
...
Đăng vào ngày 5 tháng 7 lúc 21:33
Cấu hình Swagger trong .NET Core 2.1
1. Tạo ứng dụng Web .NET Core mới với mẫu API
2. Cài đặt gói NuGet: Swashbuckle.AspNetCore
Install-Package Swashbuckle.AspNetCore -Version 4.0.1
Hoặc mở giao diện quản lý NuGet và tìm kiếm Swashbuckle.AspNetCore (phiên bản tôi sử dụng là 4.0.1)
3. Đăng ký dịch vụ phụ thuộc
Sửa phương thức ConfigureServices trong file Startup.cs
public voi ...
Đăng vào ngày 27 tháng 6 lúc 19:04
Giới thiệu về Swagger và SpringFox
Cài đặt Swagger với SpringFox
Để tích hợp Swagger vào dự án Maven, bạn cần thêm các dependency sau:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.5.0</version>
</dependency>
<dependency>
<groupId>io.springfox</gr ...
Đăng vào ngày 23 tháng 6 lúc 17:45
Hướng dẫn sử dụng Spring Boot 2.7.5 để xây dựng API RESTful
Spring MVC và xử lý yêu cầu HTTP
Định nghĩa endpoint
Sử dụng @RestController để tự động trả về dữ liệu JSON, tương đương với @Controller + @ResponseBody.
Ánh xạ URL bằng @RequestMapping hoặc các biến thể cụ thể như @GetMapping, @PostMapping để ràng buộc phương thức HTTP.
Nhận tham số từ client
Không dùng annotation: Spring tự động bind tha ...
Đăng vào ngày 12 tháng 6 lúc 21:14
Cấu hình Swagger hỗ trợ phiên bản API trong ASP.NET Core
Để triển khai kiểm soát phiên bản API kết hợp với tài liệu Swagger trong ứng dụng ASP.NET Core, cần sử dụng các thư viện sau:
Microsoft.AspNetCore.Mvc.Versioning
Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer
Đăng ký dịch vụ phiên bản API
builder.Services.AddApiVersioning(options =>
{
options.AssumeDefaultVersionWhenUnspecified ...
Đăng vào ngày 24 tháng 5 lúc 00:15