[Lập Trình] Cách tạo một web api đơn giản bằng asp.net

9/17/2020 10:55 AM | Lập trình

Web API là một giao diện lập trình ứng dụng (API) được sử dụng để cho phép giao tiếp hoặc tương tác với các thành phần phần mềm với nhau. ASP.NET Web API là một khuôn khổ giúp dễ dàng xây dựng Dịch vụ HTTP tiếp cận nhiều loại khách hàng, bao gồm cả trình duyệt và thiết bị di động. Sử dụng ASP.NET, API web có thể cho phép giao tiếp bởi các thiết bị khác nhau từ cùng một cơ sở dữ liệu.

29-08-2022 Remote SQL Server. Cách mở port 1433 để kết nối với sqlserver từ xa.
09-11-2023 Tạo chatbot với CHAT GPT sử dụng C#
04-11-2024 Lợi ích của việc xài react hook form thay vì validate function

Giới thiệu

Đây là hướng dẫn từng bước về API Web giải thích Web API là gì và cách tạo một API Web đơn giản bằng ASP.NET MVC và C #.

Định nghĩa API Web

Web API là một giao diện lập trình ứng dụng (API) được sử dụng để cho phép giao tiếp hoặc tương tác với các thành phần phần mềm với nhau. ASP.NET Web API là một khuôn khổ giúp dễ dàng xây dựng Dịch vụ HTTP tiếp cận nhiều loại khách hàng, bao gồm cả trình duyệt và thiết bị di động. Sử dụng ASP.NET, API web có thể cho phép giao tiếp bởi các thiết bị khác nhau từ cùng một cơ sở dữ liệu.

Sử dụng API Web

Nó được sử dụng để truy cập dữ liệu dịch vụ trong các ứng dụng web cũng như nhiều ứng dụng di động và các thiết bị bên ngoài khác.
Nó được sử dụng để tạo các dịch vụ web RESTful. REST là viết tắt của cụm từ Truyền trạng thái đại diện, là một kiểu kiến trúc dành cho các ứng dụng siêu phương tiện được nối mạng.
Nó chủ yếu được sử dụng để xây dựng các Dịch vụ Web nhẹ, dễ bảo trì và có thể mở rộng, đồng thời hỗ trợ băng thông hạn chế.
Nó được sử dụng để tạo một Dịch vụ Web HTTP đơn giản. Nó hỗ trợ XML, JSON và các định dạng dữ liệu khác.

Hãy xem hướng dẫn từng bước này để tạo một Web API đơn giản bằng ASP.NET MVC, C # và Visual Studio.

Bước 1. Tạo ứng dụng web ASP.NET trong Visual Studio

Mở Visual Studio và mở một dự án mới. Chọn Visual C # >> Web >> ASP.NET Web Application. Sau khi chọn tất cả, hãy đặt tên cho dự án và nhấn OK.

Bước 2. Chọn Mẫu API Web

Chọn API Web trong cửa sổ mẫu. Sau khi chọn Web API, chúng ta có thể thấy một số thông báo ở phía bên phải trong cửa sổ mẫu. Bây giờ, hãy nhấp vào nút OK.

Bước 3. Xem lại tệp dự án

Bây giờ, bạn đang ở trong Visual Studio với các tệp dự án được liệt kê dưới tên dự án. Chúng ta có thể thấy trong Trình khám phá giải pháp ở phía bên phải với tất cả các tệp và thư mục quan trọng như MVC. Các

Bước 4. Thêm bộ điều khiển

Bây giờ, đi tới Bộ điều khiển và mở rộng bộ điều khiển. Bây giờ, chúng ta có thể thấy “ValuesController.cs”. Nó là lớp chính cho API Web. Bộ điều khiển này được tạo theo mặc định. Nếu chúng ta cần một bộ điều khiển mới hoặc một bộ điều khiển có tên khác, chúng ta có thể tạo bộ điều khiển đó theo cách sau.

Chọn và nhấp chuột phải vào Bộ điều khiển >> Thêm >> Bộ điều khiển, giống như màn hình bên dưới.

Chọn “Bộ điều khiển API Web 2 - Rỗng" và nhấp vào nút "Thêm" từ cửa sổ "Thêm giàn phơi".

Đây là màn hình trông như thế nào.

Trong API Web, Bộ điều khiển được kế thừa bởi lớp trừu tượng “ApiController”. Nó rất quan trọng và cơ bản đối với các API Web. Không gian tên cho lớp này là “System.Web.Http”.

Bước 5. Thêm phương pháp điều khiển

Bây giờ, hãy tạo một phương thức đơn giản trong Controller, xây dựng ứng dụng và chạy nó cuối cùng. Trong API web, chúng tôi sử dụng tên phương thức là “Get ()". Chúng tôi có thể sử dụng bất kỳ tên phương thức nào khác. Hãy viết mã dưới đây trong bộ điều khiển Demo.

sử dụng System.Net;
sử dụng System.Net.Http;
sử dụng System.Web.Http;
không gian tên WebAPI.Controllers {
public class DemoController: ApiController {
chuỗi công khai Get () {
return "Chào mừng đến với API Web" ;
}
danh sách công khai <string> Get ( int Id) {
trả về Danh sách mới <string> {
"Dữ liệu1" ,
"Dữ liệu 2"
}
}
}
}

Định dạng URL để chạy API Web

Chúng tôi cần chạy định dạng URL “api / Controller_Name” của API Web. Ví dụ, trong MVC, chúng tôi xác định định dạng URL bằng cách sử dụng lớp “RouteConfig” và các phương thức tĩnh “RegisterRoutes”. Đối với API Web cũng vậy; chúng tôi đang sử dụng phương pháp tĩnh “WebApiConfig” và “Đăng ký”. Đi tới tệp “Global.aspx” mà chúng tôi có thể xem chi tiết.

Chúng tôi xác định định dạng URL của Web API bằng phương pháp tĩnh “GlobalConfiguration” và “Configure”. Chúng tôi đang chuyển phương thức “Đăng ký” từ lớp “WebApiConfig” làm đối số vào phương thức “Định cấu hình”. Nếu chúng ta chuyển đến lớp “WebApiConfig”, chúng ta có thể thấy các tuyến API Web.

Bước 6

Bây giờ, hãy xây dựng dự án của bạn và chạy định dạng URL được đề cập ở trên. Tên bộ điều khiển của chúng tôi là "Demo", vì vậy chúng tôi sẽ chạy như sau

URL. “Http: // localhost: 53027 / api / Demo”.

API Web đã trả về một kết quả ở định dạng XML hoặc JSON. Đầu ra của chúng tôi trông giống như dưới đây.

Tôi chạy http: // localhost: 53027 / api / Demo, nó sẽ gọi "Get ()". Vì không có tham số, đầu ra giống như bên dưới.

Tôi chạy http: // localhost: 53027 / api / Demo / 1, nó sẽ gọi "Get (int id)". Khi có một tham số trong phương thức, đầu ra sẽ giống như bên dưới.

Kết quả trả về dưới dạng định dạng XML.

Phần kết luận

Bài viết này sẽ giúp ích cho các bạn mới học, các bạn sinh viên và các bạn mới học. Trong bài tiếp theo, chúng ta đã học cách tạo API Web bằng ASP.NET, C # và Visual Studio.

Xem thêm: Windows Services là gì? Tại sao phải sự dụng Windows Services? Cách tạo 1 Windows Service đơn giản.

Nguồn: c-sharpcorner.com

Tin tức khác

Lợi ích của việc xài react hook form thay vì validate function

Lập trình

Sử dụng React Hook Form thay vì tự viết các hàm validate thủ công mang lại nhiều lợi ích, đặc biệt trong việc quản lý form trong ứng dụng React. Dưới đây là một số lợi ích chính của React Hook Form:
Tạo chatbot với CHAT GPT sử dụng C#

Lập trình

Trong hướng dẫn này, chúng ta sẽ đi sâu vào quá trình xây dựng chatbot bằng ChatGPT và C#. Chúng tôi sẽ đề cập đến mọi thứ, từ thiết lập quyền truy cập API ChatGPT đến triển khai chatbot của bạn. Bắt đầu nào!
Remote SQL Server. Cách mở port 1433 để kết nối với sqlserver từ xa.

Lập trình

Hiện nay nhiều người có xây dựng cơ sở dữ liệu trên server và kết nối tới để làm việc cho tiện. Nên mình chia sẻ bài viết này cho người mới nhé.
Sự khác nhau giữa Application, Virtual Direction và Site. Cách tạo 1 Virtual Direction.

Lập trình

Trong IIS, bạn có thể tạo các trang web, ứng dụng và thư mục ảo để chia sẻ thông tin với người dùng qua Internet, mạng nội bộ hoặc mạng phụ. Mặc dù các khái niệm này đã tồn tại trong các phiên bản trước của IIS, một số thay đổi trong IIS 7 trở lên ảnh hưởng đến định nghĩa và chức năng của các khái niệm này. Quan trọng nhất, các trang web, ứng dụng và thư mục ảo giờ đây hoạt động cùng nhau theo mối quan hệ phân cấp như những khối xây dựng cơ bản để lưu trữ nội dung trực tuyến và cung cấp dịch vụ trực tuyến.
Design pattern là gì? Tại sao nên sử dụng Design pattern?

Lập trình

Design pattern là các giải pháp tổng thể đã được tối ưu hóa, được tái sử dụng cho các vấn đề phổ biến trong thiết kế phần mềm mà chúng ta thường gặp phải hàng ngày. Đây là tập các giải pháp đã được suy nghĩ, đã giải quyết trong tình huống cụ thể.
CDN là gì? Khi nào thì cần xài CDN cho website

Lập trình

Thuật ngữ CDN có thể bạn sẽ bắt gặp khá nhiều bài viết trên thachpham.com, hoặc khi bạn cần một người có kinh nghiệm tư vấn giải pháp tiết kiệm băng thông máy chủ và tăng tốc độ website đều sẽ được nghe tư vấn là sử dụng CDN. Vậy CDN chính xác là cái gì, có bao nhiêu loại CDN, và website của bạn có thích hợp để sử dụng CDN không thì bài này sẽ cung cấp cho bạn các thông tin cần thiết đó.
Giao thức HTTP và HTTPS là gì? Tại sao nên sử dụng HTTPS?

Lập trình

Môi trường internet phát triển, kéo theo tội phạm mạng tăng cao, vì thế cần có những chuẩn bảo mật web cao hơn. Đó là lí do giao thức HTTPS dần thay thế hoàn toàn HTTP. Vậy, giao thức HTTPS là gì? HTTP và HTTPS khác nhau như thế nào? Và tại sao các website nên dùng HTTPS thay vì HTTP? Bài viết này sẽ giúp bạn giải đáp tất cả những thắc mắc đó.