Thai  Son

Thai Son

1660050900

Amazon API Gateway với .NET

Trong bài viết tổng hợp này, chúng ta sẽ tìm hiểu Amazon API Gateway với ngăn xếp .NET. Sử dụng điều này, chúng tôi sẽ có thể đưa AWS Lambdas ra thế giới bên ngoài một cách khá dễ dàng.

Trong bài viết trước, chúng ta đã tìm hiểu về cách làm việc với AWS Lambda bằng cách sử dụng .NET, đây là một điểm quan trọng để bắt đầu với các ứng dụng Serverless. Mặc dù chúng tôi đã xây dựng và triển khai các Lambdas đó trên AWS, nhưng chúng tôi chưa bao giờ thực sự thảo luận về cách chúng tôi sẽ khiến chúng bị thế giới bên ngoài gọi ra.

Tiếp tục trong hướng dẫn toàn diện này, chúng tôi sẽ xây dựng một ứng dụng không máy chủ hoàn chỉnh tích hợp liền mạch giữa Amazon API Gateway, Lambda, DynamoDb cho Persistence và Cloudwatch cho mục đích ghi nhật ký.

Bạn có thể tìm thấy mã nguồn của việc triển khai tại đây .

Amazon API Gateway là gì?

Amazon API Gateway là một dịch vụ được quản lý hoàn toàn cho phép bạn tạo Cổng, về cơ bản đóng vai trò như một cánh cửa dẫn vào thế giới logic kinh doanh cho ứng dụng của bạn. Với dịch vụ này, về cơ bản bạn để lộ các điểm cuối khi truy cập kết nối với AWS Lambdas, điểm cuối công khai và nhiều Dịch vụ AWS khác tùy thuộc vào cách bạn xây dựng Amazon API Gateway.

Giả sử một số ứng dụng chạy trên internet cần quyền truy cập vào logic nghiệp vụ nằm trong lambda của bạn. Các ứng dụng khách này sẽ kết nối với Amazon API Gateway, nội bộ sẽ chuyển hướng yêu cầu đến AWS Lambda được liên kết hoặc các dịch vụ khác mà bạn đã định cấu hình.

Chúng ta hãy xem xét biểu diễn dạng sơ đồ về luồng yêu cầu chung sẽ trông như thế nào thông qua API Gateway.

Amazon API Gateway với .NET

Như bạn có thể thấy, khách hàng truy cập Cổng kết nối nội bộ với một dịch vụ. Ví dụ,

  • www. <url-of-aws-gateway> / test -> sẽ chuyển hướng đến lambda có tên test-lambda
  • www. <url-of-aws-gateway> / get-Students -> sẽ chuyển hướng đến lambda trả về danh sách sinh viên
  • www. <url-of-aws-gateway> / weather? city = trivandrum -> sẽ chuyển hướng đến điểm cuối API thời tiết công cộng, điểm cuối này sẽ trả về dữ liệu thời tiết của thành phố Trivandrum.

Giờ đây, Cổng API thường là một phần quan trọng của toàn bộ hệ sinh thái AWS Serverless vì nó làm cho việc truy cập Dịch vụ AWS của chúng tôi trở nên khá thú vị và dễ dàng ở mọi quy mô.

API AWS REST so với API HTTP

AWS hỗ trợ hai phiên bản của Dịch vụ cổng API. Bản phát hành ban đầu dành cho biến thể REST API bao gồm rất nhiều tính năng để thiết kế, phát triển và duy trì API Gateway của bạn. Sau đó, vào khoảng năm 2019, AWS giới thiệu các API HTTP giúp đơn giản hóa việc tạo và triển khai Gateway. Đừng nhầm lẫn với việc đặt tên, cả hai phiên bản này đều được xây dựng trên giao thức HTTP tuân theo các quy ước REST. AWS nội bộ đặt tên chúng là v1 (API REST) ​​và v2 (API HTTP)

Có khá nhiều khác biệt đáng kể giữa các phiên bản này bao gồm hiệu suất, giá cả và trải nghiệm phát triển. Tóm lại, HTTP Apis chiến thắng ở hầu hết các phòng ban và nên là lựa chọn của bạn hầu hết thời gian.

  • Đầu tiên, các API HTTP có nghĩa là có hiệu suất tốt hơn và gần như hiệu quả hơn 10-15% so với API REST.
  • Về giá cả, đối với 300 Triệu yêu cầu đầu tiên mỗi tháng, API HTTP sẽ khiến bạn chỉ mất 1 USD, trong khi, đối với cùng một khối lượng, API REST có giá khoảng 3,5 USD. Đây là một sự khác biệt rất lớn. Lưu ý rằng Bậc miễn phí của AWS bao gồm 1 triệu API (REST & HTTP) mỗi tháng trong 12 tháng đầu tiên hoàn toàn miễn phí. Đủ thời gian để khám phá cả hai công nghệ thú vị này, phải không?
  • Trải nghiệm người dùng do bảng điều khiển AWS cung cấp trong khi phát triển các cổng này hoàn toàn khác với nhau.
  • REST API hỗ trợ các điểm cuối được tối ưu hóa cạnh để đảm bảo rằng các điểm cuối của bạn được phân phối cao trên toàn cầu, trong khi các điểm cuối HTTP chỉ hỗ trợ triển khai theo khu vực, điều này có thể góp phần làm chậm phản hồi một chút.
  • Cả hai điều này đều có tính bảo mật cao.
  • Việc triển khai Canary được bao gồm với API REST chứ không phải với API HTTP nếu đây là một vấn đề lớn đối với chiến lược triển khai của bạn.

Để so sánh thêm, hãy tham khảo hướng dẫn dành cho nhà phát triển của AWS để so sánh cả hai phiên bản này. Mặc dù các API HTTP rẻ hơn REST, nhưng chắc chắn có khá nhiều tính năng được bao gồm trong API REST để biện minh cho sự khác biệt về giá cả.

Đối với phần trình diễn của chúng tôi, chúng tôi sẽ sử dụng các API HTTP. Có thể trong một bài viết sau, chúng ta sẽ tìm hiểu các API REST. Về mặt khái niệm, cả hai điều này gần như giống nhau. Chúng tôi sẽ sử dụng Cộng đồng Visual Studio 2022 cùng với tiện ích mở rộng AWS SDK Kit như chúng tôi đã làm trong bài viết trước trên Lambda để phát triển, thử nghiệm, thử nghiệm và xuất bản Lambdas của chúng tôi lên Đám mây AWS.

Điều quan trọng là bạn đã xem qua bài viết trước về AWS Lambda trên .NET, nơi chúng tôi đã thiết lập Thông tin đăng nhập AWS qua CLI, Cài đặt Bộ công cụ AWS trên Visual Studio Code. Nếu không, hãy tham khảo bài đăng trên blog này.

Xây dựng và xuất bản AWS Lambda với .NET

Đầu tiên, hãy mở Visual Studio 2022 và tạo một giải pháp trống. Tôi đặt tên giải pháp của mình là AWSServerless.Dotnet.Demo . Về cơ bản, chúng tôi sẽ có 2 dự án Lambda trong này, chúng tôi sẽ bổ sung dần dần.

  1. Một Lambda giả trả lại tin nhắn Xin chào. Lambda này sẽ được sử dụng để giới thiệu các thông tin và kiến ​​thức cơ bản về tích hợp Amazon API Gateway.
  2. Một Student Lambda, mà chúng tôi sẽ thêm nhiều trình xử lý Hàm có thể thực hiện một số hoạt động CRUD cơ bản đối với DynamoDB. (Tái bút, tôi đã viết một bài báo về Bắt đầu với DynamoDB bằng .NET. Bạn cũng nên kiểm tra.)

Trước khi tiếp tục, hãy đảm bảo rằng bạn đã có những điều sau đây.

  • Thiết lập thông tin đăng nhập AWS qua AWS CLI.
  • Bộ công cụ AWS được cài đặt trên Cài đặt Visual Studio của bạn.
  • Có Tài khoản AWS. Một Bậc miễn phí sẽ là quá đủ.

Bạn có thể xem thêm thông tin liên quan đến các bước trên trong các bài viết trước của tôi về Ứng dụng AWS Serverless với .NET.

tạo dự án trống không có máy chủ Amazon API Gateway với .NET - AWS Lambda & DynamoDB Tích hợp

Hãy thêm dự án Lambda đầu tiên của chúng tôi vào Giải pháp trống của chúng tôi. Nhấp chuột phải vào Giải pháp tại Visual Studio và nhấn Thêm dự án mới. Giả sử rằng bạn đã cài đặt Bộ công cụ AWS trên Phiên bản Visual Studio của mình, bạn có thể tìm kiếm AWS Lambda trong cửa sổ bật lên 'Thêm dự án mới' xuất hiện.

devenv iArkd7DjVv Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Nhấp vào Tiếp theo. Ở đây chúng ta hãy đặt tên lambda HelloLambda. Như đã đề cập trước đó, đây sẽ là một lambda đơn giản giúp chúng ta hiểu toàn bộ quá trình tích hợp với Amazon API Gateway với .NET sẽ như thế nào. Khi bạn được nhắc chọn một bản thiết kế cho lambda mới của mình, hãy chọn `` Chức năng trống ''. Điều này cung cấp cho chúng tôi một phương tiện rõ ràng để bắt đầu xây dựng Lambda đơn giản của chúng tôi.

Bạn đã quen với cấu trúc thư mục của Dự án AWS Lambda. Nếu chưa, hãy xem qua bài viết này. Mở Function.cs / FunctionHandler. Bây giờ chúng ta sẽ đính kèm Trình xử lý này với Cổng API của mình, chúng ta cần thực hiện một số sửa đổi nhỏ đối với chữ ký của phương thức này. Nhưng trước đó, hãy cài đặt một gói cho dự án Lambda này có chứa các hợp đồng. Bạn có thể mở Bảng điều khiển Trình quản lý Gói và chạy phần sau để cài đặt gói.

Install-Package Amazon.Lambda.APIGatewayEvents

Hãy bắt đầu và thay đổi FunctionHandler của chúng ta ngay bây giờ.

public APIGatewayHttpApiV2ProxyResponse FunctionHandler(APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context)
{
request.QueryStringParameters.TryGetValue("name", out var name);
name = name ?? "John Doe";
var message = $"Hello {name}, from AWS Lambda";
return new APIGatewayHttpApiV2ProxyResponse
{
Body = message,
StatusCode = 200
};
}

APIGatewayHttpApiV2ProxyRequest đại diện cho yêu cầu đến từ một API HTTP. Nếu bạn nghĩ về điều đó hoặc nếu bạn nhìn lại sơ đồ luồng đầu tiên mà chúng tôi có, yêu cầu mà Lambda nhận được không phải trực tiếp từ khách hàng, mà là yêu cầu từ chính Amazon API Gateway. Vì vậy, trong trường hợp này, API Gateway sẽ gửi một yêu cầu đến Lambda với kiểu APIGatewayHttpApiV2ProxyRequest . Tương tự, APIGatewayHttpApiV2ProxyResponse là loại phản hồi mà Lambda trả lại cho Amazon API Gateway. Bạn cũng có thể bỏ qua phần phản hồi này và thay vào đó trả lại một số dữ liệu quan trọng theo yêu cầu kinh doanh, chẳng hạn như danh sách Học viên, mà chúng tôi sẽ thực hiện trong khi xây dựng Lambda tiếp theo của chúng tôi sâu hơn trong hướng dẫn này.

Vì vậy, đây là những thay đổi lớn trong Lambda để hỗ trợ toàn bộ tính năng tích hợp API Gateway. Ngoài ra, trình xử lý Hàm giờ đây trả về một thông báo có nội dung “Xin chào {name}, từ AWS Lambda”. Một điều khác ở đây là, từ bên trong Lambda, bạn có thể truy cập vào ngữ cảnh đến, bao gồm Chuỗi truy vấn, Tham số đường dẫn, Đường dẫn, v.v. Đối với Lambda này, tôi hy vọng yêu cầu đến sẽ có tham số Truy vấn là tên (… / hello? Name = Mukesh), sau đó sẽ được thêm vào thông báo mà nó trả về cuối cùng.

Nếu Tham số truy vấn không tồn tại, nó sẽ tiếp tục với tên mặc định, đó là John Doe. Lưu ý rằng chúng tôi đang trả lại phản hồi dưới dạng loại APIGatewayHttpApiV2ProxyResponse, trong đó Body là thông báo thực và chúng tôi cung cấp mã trạng thái là 200 SUCCESS.

Đó là nó cho Lambda đầu tiên của chúng tôi. Hãy xuất bản nó lên AWS và Mock Kiểm tra nó cục bộ trong Visual Studio. Nhấp chuột phải vào dự án HelloLambda và nhấp vào Xuất bản lên AWS Lambda. Bạn sẽ thấy cửa sổ bật lên sau.

hình ảnh Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Một số chi tiết đầu tiên được công cụ điền tự động, với điều kiện là bạn đã thiết lập Thông tin đăng nhập AWS địa phương, Khu vực và hồ sơ của mình.

  • Tên hàm là tên mà Lambda sẽ được nhận dạng trên tài khoản AWS của bạn.
  • Mô tả - như tên cho thấy.
  • Xử lý là khá quan trọng ở đây. Giả sử Function.cs của bạn có thể có nhiều phương thức Xử lý. Phương thức Handler này ánh xạ đến chức năng chính xác mà bạn cần Lambda của mình trỏ tới. Trong trường hợp của chúng ta, đó là HelloLambda :: HelloLambda.Function :: FunctionHandler. Hãy ghi nhớ điều này, vì chúng tôi sẽ sử dụng trường này ở phần sau trong bài viết của chúng tôi.

Nhấn tiếp.

devenv oEzQI2HY6h Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Trong màn hình tiếp theo, thay đổi duy nhất bạn sẽ phải làm là chọn đúng vai trò cần thiết. Trong trường hợp của chúng tôi, đó là AWSLambdaBasicExecutionRole. Điều này đi kèm với quyền ghi Nhật ký vào AWS Cloudwatch. Đó là nó. Nhấp vào Tải lên. AWS bắt đầu tạo các Vai trò cần thiết, chạy một số lệnh để xây dựng và phát hành cục bộ Lambda của bạn, nén các thư viện đã xuất bản và tải nó lên AWS, cuối cùng tạo ra Lambda sáng bóng mới của bạn.

Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Sau khi hoàn tất, bạn có thể mở Bảng điều khiển quản lý AWS, điều hướng đến Lambdas và xác minh rằng Lambda mới của chúng tôi đã được tạo.

image 2 Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Quay lại Visual Studio, bạn có thể thấy rằng Publish Wizard sẽ mở ra một công cụ nhỏ giúp kiểm tra Lambda Straight từ Visual Studio. Ồ, và nếu bạn chưa biết, bạn cũng có thể chỉ cần chạy ứng dụng Lambda ở chế độ Gỡ lỗi và Visual Studio sẽ kích hoạt Công cụ Mock về cơ bản giúp kiểm tra và gỡ lỗi mã Lambda của bạn.

Bây giờ, chúng ta hãy khám phá công cụ được tích hợp trong giao diện Visual Studio. Đây là một ảnh chụp màn hình bên dưới.

image 1 Amazon API Gateway với .NET - AWS Lambda & DynamoDB Tích hợp

Đầu tiên, giao diện này cho phép bạn gửi các yêu cầu giả trực tiếp đến Lambda của bạn đã được triển khai tới AWS. Nhấp vào menu thả xuống Yêu cầu mẫu và chọn API Gateway AWS Proxy. Công cụ sẽ điền vào một yêu cầu mẫu. Ở đây, như tôi đã làm, bạn có thể thêm khóa tên / giá trị vào các tham số chuỗi Truy vấn. Có khá nhiều tài sản để tìm kiếm xung quanh đây. Khi bạn nhấp vào Gọi, phản hồi sẽ có thông báo của chúng tôi với mã Trạng thái là 200.

Bây giờ, mặc dù Lambda đã sẵn sàng, chúng tôi thực sự không có cách nào để truy cập chức năng này ngoài các công cụ gỡ lỗi VS. Vì vậy, chúng tôi cần một liên kết / điểm cuối mà chúng tôi gửi yêu cầu và chúng tôi mong đợi một yêu cầu tương tự từ Lambda. Đây là nơi Amazon API Gateway xuất hiện trong bức tranh.

Tạo Amazon API Gateway với .NET

Hãy bắt đầu thiết kế Cổng API Amazon đầu tiên của chúng tôi. Tìm kiếm API Gateway trong thanh tìm kiếm mà bạn thấy trong Bảng điều khiển quản lý AWS. Bạn sẽ thấy trang đích mặc định cho Amazon API Gateway. Tại đây, bạn sẽ thấy các lựa chọn để chọn Loại API. Vì chúng tôi sẽ sử dụng API HTTP, hãy nhấp vào nút Xây dựng được liên kết với nó.

chrome HZudzLTStT Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Cho rằng Lambda của chúng tôi đã được tạo thành công, bạn có thể chọn kiểu Tích hợp là Lambda và chọn hàm hello Lambda của chúng tôi. Đảm bảo chúng tôi tuân theo Phiên bản 2.0 của tải trọng vì đây là phiên bản mới nhất. Ngoài ra, hãy đảm bảo chọn đúng khu vực AWS. Trong trường hợp của tôi, đó là ap-nam-1. Sau khi hoàn thành, hãy nhấp vào tiếp theo.

chrome ZaswQgDPsT Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Tiếp theo là một phần thú vị, nơi chúng tôi định cấu hình các tuyến đường thực tế có thể gọi hello Lambda của chúng tôi. Bạn có thể thấy rằng tôi đã đặt nó thành một phương thức GET sẽ có điểm cuối là / hello và sẽ nhắm mục tiêu đến Hello Lambda. Vì vậy, về cơ bản, khi chúng tôi tạo Cổng API, AWS sẽ cung cấp cho chúng tôi một URL Điểm cuối, mà nếu chúng tôi thêm a / hello và gửi phương thức GET với các tham số truy vấn thích hợp sẽ kích hoạt Lambda và trả về Phản hồi dự kiến.

Lưu ý rằng bạn có thể nhiều tuyến đường và tích hợp ở đây. Chúng tôi sẽ khám phá điều này khi chúng tôi tạo Cổng API đầy đủ của chúng tôi trong phần sau của bài viết này.

chrome 1j5EYx3xWe Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Tiếp theo, Wizard sẽ yêu cầu chúng ta tạo các giai đoạn. Điều này sẽ hữu ích nếu chúng ta muốn triển khai Amazon API Gateway của mình cho các giai đoạn khác nhau như dev, prod và staging. Nhưng hiện tại, hãy giữ nó làm giá trị mặc định là `$ default` và nhấp vào Tiếp theo.

Tại đây, bạn có thể xem lại các thay đổi của mình và Triển khai Gateway của mình. Đó là nó, đơn giản như vậy.

Trong màn hình bên dưới, bạn có thể thấy URL của Amazon API Gateway mà chúng tôi vừa tạo. Sao chép cái này và mở Postman hoặc bất kỳ công cụ kiểm tra API nào bạn sử dụng. Ngoài ra, vì nó chỉ là một phương pháp GET, bạn có thể sử dụng Trình duyệt để kiểm tra Gateway của chúng tôi.

chrome kmkvkIZHmM Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Hãy kiểm tra API Gateway của chúng tôi sẽ phản hồi như thế nào. Tôi sẽ sử dụng Postman để thử nghiệm. Đảm bảo rằng đó là phương thức GET, nếu không Gateway sẽ thông báo rằng không tìm thấy điểm cuối như vậy.

Trong ảnh chụp màn hình bên dưới, bạn có thể thấy rằng tôi đã gửi một yêu cầu đến điểm cuối / hello và chuyển tên tham số truy vấn làm Tên của tôi và bạn cũng có thể thấy phản hồi mong đợi từ Lambda. Khá đơn giản phải không? Vui lòng truy cập Hello Lambda để hiểu thêm về nó.

Postman 09XFb6JnKd Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Khám phá giao diện bảng điều khiển Amazon API Gateway

Bây giờ chúng tôi đã tạo Cổng API Amazon đầu tiên của mình với AWS Lambdas do .NET hỗ trợ, hãy cùng khám phá Giao diện và Tính năng được cung cấp trên Cổng API Amazon.

Trên trang chủ, bạn có thể xem danh sách các Cổng do bạn tạo trong một Vùng AWS cụ thể.

chrome RYg52eeVpW Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Khi bạn đi vào một API Gateway cụ thể, bạn sẽ có quyền truy cập vào một loạt các tính năng thú vị để điều chỉnh Gateway của mình.

chrome C3lh3VJBk3 Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Từ đây, bạn có thể:

  • Thêm các tuyến đường khác vào Amazon API Gateway hiện có.
  • Bảo mật Amazon API Gateway bằng Lambdas và JWT. Chúng ta sẽ đi sâu tìm hiểu vấn đề này trong bài viết tiếp theo!
  • Quản lý Tích hợp và Lambdas.
  • Định cấu hình Chính sách CORS.
  • Xuất / Nhập định nghĩa OpenAPI.
  • Ghi Nhật ký truy cập nếu cần. Vì vậy, mỗi khi có yêu cầu được gửi qua cổng API, yêu cầu đó sẽ được đăng nhập vào Cloudwatch. Bạn sẽ phải chỉ định đích đến của Log Group cho việc này. Chúng ta sẽ xem xét vấn đề này ở phần sau của bài viết.
  • Quản lý / Tạo giai đoạn, v.v.

Bây giờ chúng ta đã có hiểu biết cơ bản về cách hoạt động của Amazon API Gateway với .NET, bây giờ chúng ta hãy xây dựng một ứng dụng Serverless nâng cao hơn sử dụng AWS Lambda, nhiều Trình xử lý chức năng, Cloudwatch, DynamoDB để lưu trữ dữ liệu và cuối cùng tích hợp tất cả những Lambdas này bằng cách sử dụng Amazon API Gateway.

Quản lý sinh viên xây dựng AWS Lambda với .NET

Chúng tôi sẽ xây dựng một API đơn giản có thể lấy tất cả thông tin chi tiết về sinh viên, lấy sinh viên theo ID và tạo hồ sơ Sinh viên mới. Thêm một dự án Lambda mới vào Giải pháp của chúng tôi và đặt tên là StudentLambda. Và vâng, chúng tôi sẽ tạo nhiều Lambda từ một Dự án Lambda duy nhất. Bạn có thể tự do tạo các dự án riêng biệt cho từng chức năng. Nhưng đối với phạm vi ứng dụng và yêu cầu hiện tại, nó không thực sự cần thiết. Chúng tôi sẽ nhồi tất cả 3 hàm Lambda vào một dự án .NET Lambda duy nhất và sử dụng FunctionHandlers để triển khai riêng biệt tất cả các Lambda sang AWS.

Trước khi bắt đầu, hãy đảm bảo cài đặt các gói Nuget sau vào dự án StudentLambda của bạn thông qua Bảng điều khiển Trình quản lý Gói.

Install-Package Amazon.Lambda.APIGatewayEvents
Install-Package AWSSDK.DynamoDBv2
Install-Package Newtonsoft.Json

Như bạn đã biết, gói đầu tiên dành riêng cho việc sử dụng các hợp đồng Amazon API Gateway trong .NET Lambda của chúng tôi.

Gói DynamoDB cho phép Lambda của chúng tôi giao tiếp với DynamoDB của chúng tôi. Nếu bạn không biết cách hoạt động của DynamoDB, tôi đã viết một hướng dẫn đầy đủ về nó ở đây . Tôi đã xây dựng một CRUD ASP.NET Core WebAPI đơn giản để lưu trữ dữ liệu vào bảng AWS DynamoDB.

Tiếp theo, hãy xác định Mô hình Sinh viên. Với gốc của dự án StudentLambda, thêm một lớp mới và đặt tên là Student.cs

namespace StudentLambda
{
[DynamoDBTable("students")]
public class Student
{
[DynamoDBHashKey("id")]
public int? Id { get; set; }
[DynamoDBProperty("first_name")]
public string? FirstName { get; set; }
[DynamoDBProperty("last_name")]
public string? LastName { get; set; }
[DynamoDBProperty("class")]
public int Class { get; set; }
}
}

Bây giờ điều hướng đến AWS DynamoDB và tạo một bảng mới ở đó như sau.

chrome FCz71W3ljT Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Sau khi bạn tạo bảng, AWS sẽ mất vài giây để cung cấp Bảng cho đám mây. Hãy thêm một bản ghi mẫu vào bảng này. Mở Bảng, nhấn Khám phá Mục trong Bảng -> Tạo Mục.

Chuyển sang dạng xem JSON và thêm bản ghi mẫu như sau. Lưu ý rằng các thuộc tính tôi đã sử dụng hoàn toàn giống với các thuộc tính mà chúng tôi đã xác định trong lớp Student.cs của mình. Nhấp vào Tạo.

{
"id": 1,
"first_name" : "Mukesh",
"last_name" : "Murugan",
"class" : 10
}

chrome MotUEEQAR1 Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Nhận tất cả học sinh

Hãy viết một số mã để trả về danh sách tất cả sinh viên từ bảng DynamoDB. Mở lớp Function.cs của StudentLambda. Loại bỏ phương thức FunctionHandler mặc định. và thêm chức năng sau.

public async Task<List<Student>> GetAllStudentsAsync(APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context)
{
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
DynamoDBContext dbContext = new DynamoDBContext(client);
var data = await dbContext.ScanAsync<Student>(default).GetRemainingAsync();
return data;
}

Vì vậy, chức năng này về cơ bản quét toàn bộ Bảng DynamoDB đặt tên các học sinh và trả về danh sách các Học sinh. Đơn giản vậy thôi. Lưu ý rằng chúng tôi sẽ tạo một vài Ứng dụng khách và Ngữ cảnh DynamoDB để truy cập dữ liệu của chúng tôi từ AWS Lambda.

Chúng tôi sẽ triển khai các Lambdas này sau khi cả 3 hoàn thành. Lý tưởng nhất là điểm cuối cho Lambda này sẽ là Phương thức <amazon-url> / Students [GET].

Tạo sinh viên

Tiếp theo, tới Same Function.cs của Student Lambda, hãy thêm một phương thức khác sẽ chịu trách nhiệm tạo hồ sơ sinh viên mới. Dưới đây là chức năng.

public async Task<APIGatewayHttpApiV2ProxyResponse> CreateStudentAsync(APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context)
{
var studentRequest = JsonConvert.DeserializeObject<Student>(request.Body);
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
DynamoDBContext dbContext = new DynamoDBContext(client);
await dbContext.SaveAsync(studentRequest);
var message = $"Student with Id {studentRequest?.Id} Created";
LambdaLogger.Log(message);
return new APIGatewayHttpApiV2ProxyResponse
{
Body = message,
StatusCode = 200
};
}

Vì vậy, ở đây chúng tôi mong đợi khách hàng gửi một phần thân JSON với thông tin chi tiết về sinh viên.

Dòng # 3, chúng tôi giải mã nội dung yêu cầu đến thành một đối tượng Sinh viên. Sau đó, chúng tôi tạo một ngữ cảnh DB để truy cập bảng DyoDb và Lưu hồ sơ học sinh vào cơ sở dữ liệu của chúng tôi. Sau khi hoàn tất, chúng tôi sẽ gửi lại thông báo thành công cho khách hàng dưới dạng phản hồi với mã trạng thái là 200.

Tại Dòng # 8, bạn có thể nhận thấy rằng chúng tôi đang sử dụng phiên bản LambdaLogger để ghi thông báo vào Cloudwatch LogGroup của Lambda. Điểm cuối này lý tưởng sẽ là phương thức <amazon-url> / Students [POST].

Nhận sinh viên bằng ID

Tiến tới Hàm lambda cuối cùng của chúng ta, hãy thêm một hàm có thể trả về sinh viên dựa trên ID được gửi trong yêu cầu. Đây sẽ là một Hàm hơi khác, vì chúng ta sẽ phải tìm nạp ID từ Tham số đường dẫn của yêu cầu. Ví dụ: điểm cuối triển khai này sẽ giống như <amazon-url> / students / {id}.

Sao chép Dán phương pháp sau vào Function.cs của dự án Student Lambda.

public async Task<Student> GetStudentByIdAsync(APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context)
{
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
DynamoDBContext dbContext = new DynamoDBContext(client);
string idFromPath = request.PathParameters["id"];
int id = Int32.Parse(idFromPath);
var student = await dbContext.LoadAsync<Student>(id);
if (student == null) throw new Exception("Not Found!");
return student;
}

Trong Dòng # 5, chúng tôi đang trích xuất id sinh viên từ thuộc tính tham số đường dẫn của yêu cầu. Sau khi chúng tôi tìm nạp nó, chúng tôi chuyển đổi nó thành một số nguyên và chuyển nó sang phương thức DyoDb để lấy sinh viên theo Id. Hồ sơ học sinh này được trả lại cho khách hàng như một phản hồi.

Bây giờ, tất cả các hàm Lamda đã được tạo. Hãy triển khai chúng lên AWS.

Trên Visual Studio, nhấp chuột phải vào dự án StudentLambda và nhấp vào Xuất bản lên AWS Lambda. Chúng tôi sẽ triển khai từng chức năng trong số 3 chức năng này sau cái khác.

Có 2 điểm cần lưu ý trên màn hình dưới đây. Tên hàm là 'get-all-students' và Trình xử lý trỏ đến phương thức GetAllStudentsAsync. Đây là cách chúng tôi xuất bản riêng tất cả 3 Lambda. Chắc hẳn bây giờ bạn đã có ý tưởng. Sau khi các trường này được thay đổi, hãy nhấp vào Tiếp theo.

devenv lP4870ufPw Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Trong màn hình tiếp theo, bạn sẽ cần chọn vai trò liên quan đến Lambda này. Đối với người mới bắt đầu, nó có thể là Vai trò AWSLambdaBasicExecution. Tuy nhiên, có một vấn đề với điều này. Vai trò cụ thể này chỉ cung cấp quyền truy cập để thực thi Lambda và ghi nhật ký vào Cloudwatch. Nhưng không có quyền truy cập vào bảng DynamoDB của chúng ta, phải không? Chúng tôi sẽ sửa lỗi này sau khi triển khai tất cả các Lambdas.

devenv k3q9el3o6D Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Vậy là xong, tải lên Lambda get-all-students.

Lặp lại các bước tương tự để triển khai các Lambdas còn lại. Đảm bảo rằng bạn chọn Vai trò đã được tạo cho mỗi 2 AWS Lambda này.

devenv 12JZFkHk21 Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

devenv fycfsY0BNP Cổng API Amazon với .NET - Tích hợp AWS Lambda & DynamoDB

devenv jD6jBn30hv Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Đó là nó! Đây là những chiếc Lambdas mà chúng tôi đã tạo ra cho đến bây giờ.

chrome yqXn6ON0rX Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Thêm quyền DynamoDB.

Như đã đề cập, hãy thêm Quyền DynamoDB bắt buộc vào vai trò mà chúng tôi đã tạo. Điều hướng đến AWS IAM. Đi tới Chính sách và tạo một chính sách với đặc điểm kỹ thuật sau. Như bạn thấy ở đây, chúng tôi đã chọn DynamoDB làm Dịch vụ AWS và cho phép tất cả các hành động DynamoDB cũng như tất cả các tài nguyên.

chrome Ql3GcGoy6E Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Lưu ý rằng không phải lúc nào cũng là ý kiến ​​hay khi cấp các quyền hoàn chỉnh cho một vai trò cụ thể. Nhưng để giữ mọi thứ đơn giản, chúng tôi đang làm như vậy. Bạn không nên làm điều này cho các ứng dụng sản xuất. Chỉ cung cấp các quyền thực sự được yêu cầu.

Trên trang tiếp theo, đặt tên cho chính sách và tạo nó.

chrome ycODtFF4xn Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Bây giờ chúng ta đã tạo chính sách, hãy gắn nó vào Vai trò của chúng ta. Chọn chính sách mới được tạo từ danh sách và nhấp vào đính kèm. Trên trang tiếp theo, bạn sẽ phải chọn vai trò / người dùng / nhóm mà bạn muốn đính kèm chính sách này.

chrome BXL706oAoM Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Trong trường hợp của chúng tôi, đó là lambda_exec_get-all-sinh viên

chrome mAu7ftXH2A Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Của bạn đây. Chúng tôi đã đính kèm thành công chính sách với vai trò được AWS Lambda của chúng tôi sử dụng. Bây giờ Lambda sẽ có đủ quyền để làm việc với DynamoDb.

Kết nối Amazon API Gateway với .NET AWS Lambda

Tiếp theo là phần quan trọng của hướng dẫn, để thực sự xây dựng một Cổng API để kích hoạt từng lambdas này. Mở Amazon API Gateway từ Bảng điều khiển quản lý AWS.

Cho đến nay, chúng tôi chỉ tạo ra một API Gateway duy nhất . Tạo một Cổng API mới. Như thường lệ, hãy chọn loại API HTTP và nhấn Xây dựng.

Chúng tôi đặt tên Gateway là học sinh và thêm tất cả 3 Lambdas làm Tích hợp. Đơn giản, phải không?

chrome j6Rwc9eHTU Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Trong trang tiếp theo, chúng tôi sẽ định cấu hình các tuyến đường của chúng tôi. Chúng tôi sẽ thay đổi các giá trị mặc định và thêm cấu hình bên dưới.

chrome HTdaHTJd1a Amazon API Gateway với .NET - AWS Lambda & DynamoDB Tích hợp

  • GET / sinh viên sẽ gọi tất cả sinh viên
  • GET / Students / {id} sẽ gọi get-student-by-id trong đó id là tham số đường dẫn của yêu cầu. Ví dụ, / sinh viên / 1
  • Cuối cùng, POST / sinh viên sẽ tạo một sinh viên mới, vì chúng tôi đã chuyển thông tin chi tiết của sinh viên mới dưới dạng tải trọng JSON của yêu cầu.
     

Để sân khấu như mặc định và tiếp tục tạo Cổng.

chrome b5Pqmem97h Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Đó là nó. Hãy cùng Postman kiểm tra điểm cuối này.

Đầu tiên, tôi đang thử nghiệm Lambda get-al-Students. Tôi đã gửi một yêu cầu GET tới <url> / sinh viên. Như mong đợi, bạn sẽ thấy một danh sách các sinh viên là phản hồi. Hiện tại, chúng tôi chỉ có một bản ghi trong cơ sở dữ liệu của mình.

Postman IEQHc2RddV Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Tiếp theo, hãy kiểm tra Lambda get-student-by-id. Tôi đã gửi một yêu cầu GET tới <url> / Students / 1. Và đúng như vậy, nó trả về thông tin chi tiết của học sinh với Id 1.

Postman Z6R9hqnoka Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Cuối cùng, hãy tạo một học sinh mới. Đã gửi một yêu cầu POST đến điểm cuối <url> / students cùng với thông tin chi tiết về học sinh. Và phản hồi là Sinh viên của chúng ta được tạo với ID 2!

Postman 7lDzMoDjEr Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Ngoài ra, hãy nhớ rằng chúng tôi đã viết một Logger nhỏ trong Create-Student Lambda của chúng tôi? Hãy điều hướng đến Cloudwatch / Log Groups / create-student và kiểm tra nhật ký.

chrome kBWX1ReSVr Amazon API Gateway với .NET - Tích hợp AWS Lambda & DynamoDB

Bạn có thể thấy rằng thông báo nhật ký của chúng tôi cũng được in ở đây.

Đó là một kết thúc cho bài báo toàn diện này. Trong bài tiếp theo, chúng ta sẽ tìm hiểu về cách bảo mật API Gateway bằng Lambda Authorizer! Hiện tại, cổng API mà chúng tôi đã tạo là một điểm cuối công khai.

MẸO quan trọng: Đảm bảo rằng bạn luôn xóa Tài nguyên AWS mà bạn đã tạo sau khi khám phá xong chúng. Điều này giúp giảm Chi phí phát sinh, mặc dù Bậc MIỄN PHÍ cung cấp cho bạn một lượng khá lớn các yêu cầu MIỄN PHÍ để làm việc.

Bản tóm tắt

Trong bài viết này, chúng ta đã tìm hiểu về cách bắt đầu với Amazon API Gateway với .NET. Ở đây, chúng ta đã tìm hiểu về cách tạo các Lambdas cơ bản tương thích với Amazon API Gateway, tích hợp chúng vào DynamoDB, thêm Nhiều Lambdas vào một Gateway cụ thể, Ghi nhật ký và hơn thế nữa. Điều này sẽ cung cấp cho bạn một ý tưởng vững chắc để làm việc với ứng dụng AWS Serverless. Là phần tiếp theo của ứng dụng AWS Serverless với .NET này, chúng ta sẽ khám phá cách bảo mật Cổng API và làm việc với SAM, v.v. Giữ nguyên. Bạn có thể theo dõi bản tin này để nhận thông báo khi tôi đăng bài mới - https://www.getrevue.co/profile/iammukeshm

Hãy chia sẻ bài viết này với đồng nghiệp và vòng kết nối nhà phát triển của bạn nếu bạn thấy điều này thú vị. Bạn có thể tìm thấy  mã nguồn của dự án  tại đây. Cảm ơn!  

 Nguồn: https://codewithmukesh.com/blog/amazon-api-gateway-with-dotnet/

 #dotnet #amazon #api 

What is GEEK

Buddha Community

Amazon API Gateway với .NET
Einar  Hintz

Einar Hintz

1602560783

jQuery Ajax CRUD in ASP.NET Core MVC with Modal Popup

In this article, we’ll discuss how to use jQuery Ajax for ASP.NET Core MVC CRUD Operations using Bootstrap Modal. With jQuery Ajax, we can make HTTP request to controller action methods without reloading the entire page, like a single page application.

To demonstrate CRUD operations – insert, update, delete and retrieve, the project will be dealing with details of a normal bank transaction. GitHub repository for this demo project : https://bit.ly/33KTJAu.

Sub-topics discussed :

  • Form design for insert and update operation.
  • Display forms in modal popup dialog.
  • Form post using jQuery Ajax.
  • Implement MVC CRUD operations with jQuery Ajax.
  • Loading spinner in .NET Core MVC.
  • Prevent direct access to MVC action method.

Create ASP.NET Core MVC Project

In Visual Studio 2019, Go to File > New > Project (Ctrl + Shift + N).

From new project window, Select Asp.Net Core Web Application_._

Image showing how to create ASP.NET Core Web API project in Visual Studio.

Once you provide the project name and location. Select Web Application(Model-View-Controller) and uncheck HTTPS Configuration. Above steps will create a brand new ASP.NET Core MVC project.

Showing project template selection for .NET Core MVC.

Setup a Database

Let’s create a database for this application using Entity Framework Core. For that we’ve to install corresponding NuGet Packages. Right click on project from solution explorer, select Manage NuGet Packages_,_ From browse tab, install following 3 packages.

Showing list of NuGet Packages for Entity Framework Core

Now let’s define DB model class file – /Models/TransactionModel.cs.

public class TransactionModel
{
    [Key]
    public int TransactionId { get; set; }

    [Column(TypeName ="nvarchar(12)")]
    [DisplayName("Account Number")]
    [Required(ErrorMessage ="This Field is required.")]
    [MaxLength(12,ErrorMessage ="Maximum 12 characters only")]
    public string AccountNumber { get; set; }

    [Column(TypeName ="nvarchar(100)")]
    [DisplayName("Beneficiary Name")]
    [Required(ErrorMessage = "This Field is required.")]
    public string BeneficiaryName { get; set; }

    [Column(TypeName ="nvarchar(100)")]
    [DisplayName("Bank Name")]
    [Required(ErrorMessage = "This Field is required.")]
    public string BankName { get; set; }

    [Column(TypeName ="nvarchar(11)")]
    [DisplayName("SWIFT Code")]
    [Required(ErrorMessage = "This Field is required.")]
    [MaxLength(11)]
    public string SWIFTCode { get; set; }

    [DisplayName("Amount")]
    [Required(ErrorMessage = "This Field is required.")]
    public int Amount { get; set; }

    [DisplayFormat(DataFormatString = "{0:MM/dd/yyyy}")]
    public DateTime Date { get; set; }
}

C#Copy

Here we’ve defined model properties for the transaction with proper validation. Now let’s define  DbContextclass for EF Core.

#asp.net core article #asp.net core #add loading spinner in asp.net core #asp.net core crud without reloading #asp.net core jquery ajax form #asp.net core modal dialog #asp.net core mvc crud using jquery ajax #asp.net core mvc with jquery and ajax #asp.net core popup window #bootstrap modal popup in asp.net core mvc. bootstrap modal popup in asp.net core #delete and viewall in asp.net core #jquery ajax - insert #jquery ajax form post #modal popup dialog in asp.net core #no direct access action method #update #validation in modal popup

Autumn  Blick

Autumn Blick

1601381326

Public ASX100 APIs: The Essential List

We’ve conducted some initial research into the public APIs of the ASX100 because we regularly have conversations about what others are doing with their APIs and what best practices look like. Being able to point to good local examples and explain what is happening in Australia is a key part of this conversation.

Method

The method used for this initial research was to obtain a list of the ASX100 (as of 18 September 2020). Then work through each company looking at the following:

  1. Whether the company had a public API: this was found by googling “[company name] API” and “[company name] API developer” and “[company name] developer portal”. Sometimes the company’s website was navigated or searched.
  2. Some data points about the API were noted, such as the URL of the portal/documentation and the method they used to publish the API (portal, documentation, web page).
  3. Observations were recorded that piqued the interest of the researchers (you will find these below).
  4. Other notes were made to support future research.
  5. You will find a summary of the data in the infographic below.

Data

With regards to how the APIs are shared:

#api #api-development #api-analytics #apis #api-integration #api-testing #api-security #api-gateway

Top 10 API Security Threats Every API Team Should Know

As more and more data is exposed via APIs either as API-first companies or for the explosion of single page apps/JAMStack, API security can no longer be an afterthought. The hard part about APIs is that it provides direct access to large amounts of data while bypassing browser precautions. Instead of worrying about SQL injection and XSS issues, you should be concerned about the bad actor who was able to paginate through all your customer records and their data.

Typical prevention mechanisms like Captchas and browser fingerprinting won’t work since APIs by design need to handle a very large number of API accesses even by a single customer. So where do you start? The first thing is to put yourself in the shoes of a hacker and then instrument your APIs to detect and block common attacks along with unknown unknowns for zero-day exploits. Some of these are on the OWASP Security API list, but not all.

Insecure pagination and resource limits

Most APIs provide access to resources that are lists of entities such as /users or /widgets. A client such as a browser would typically filter and paginate through this list to limit the number items returned to a client like so:

First Call: GET /items?skip=0&take=10 
Second Call: GET /items?skip=10&take=10

However, if that entity has any PII or other information, then a hacker could scrape that endpoint to get a dump of all entities in your database. This could be most dangerous if those entities accidently exposed PII or other sensitive information, but could also be dangerous in providing competitors or others with adoption and usage stats for your business or provide scammers with a way to get large email lists. See how Venmo data was scraped

A naive protection mechanism would be to check the take count and throw an error if greater than 100 or 1000. The problem with this is two-fold:

  1. For data APIs, legitimate customers may need to fetch and sync a large number of records such as via cron jobs. Artificially small pagination limits can force your API to be very chatty decreasing overall throughput. Max limits are to ensure memory and scalability requirements are met (and prevent certain DDoS attacks), not to guarantee security.
  2. This offers zero protection to a hacker that writes a simple script that sleeps a random delay between repeated accesses.
skip = 0
while True:    response = requests.post('https://api.acmeinc.com/widgets?take=10&skip=' + skip),                      headers={'Authorization': 'Bearer' + ' ' + sys.argv[1]})    print("Fetched 10 items")    sleep(randint(100,1000))    skip += 10

How to secure against pagination attacks

To secure against pagination attacks, you should track how many items of a single resource are accessed within a certain time period for each user or API key rather than just at the request level. By tracking API resource access at the user level, you can block a user or API key once they hit a threshold such as “touched 1,000,000 items in a one hour period”. This is dependent on your API use case and can even be dependent on their subscription with you. Like a Captcha, this can slow down the speed that a hacker can exploit your API, like a Captcha if they have to create a new user account manually to create a new API key.

Insecure API key generation

Most APIs are protected by some sort of API key or JWT (JSON Web Token). This provides a natural way to track and protect your API as API security tools can detect abnormal API behavior and block access to an API key automatically. However, hackers will want to outsmart these mechanisms by generating and using a large pool of API keys from a large number of users just like a web hacker would use a large pool of IP addresses to circumvent DDoS protection.

How to secure against API key pools

The easiest way to secure against these types of attacks is by requiring a human to sign up for your service and generate API keys. Bot traffic can be prevented with things like Captcha and 2-Factor Authentication. Unless there is a legitimate business case, new users who sign up for your service should not have the ability to generate API keys programmatically. Instead, only trusted customers should have the ability to generate API keys programmatically. Go one step further and ensure any anomaly detection for abnormal behavior is done at the user and account level, not just for each API key.

Accidental key exposure

APIs are used in a way that increases the probability credentials are leaked:

  1. APIs are expected to be accessed over indefinite time periods, which increases the probability that a hacker obtains a valid API key that’s not expired. You save that API key in a server environment variable and forget about it. This is a drastic contrast to a user logging into an interactive website where the session expires after a short duration.
  2. The consumer of an API has direct access to the credentials such as when debugging via Postman or CURL. It only takes a single developer to accidently copy/pastes the CURL command containing the API key into a public forum like in GitHub Issues or Stack Overflow.
  3. API keys are usually bearer tokens without requiring any other identifying information. APIs cannot leverage things like one-time use tokens or 2-factor authentication.

If a key is exposed due to user error, one may think you as the API provider has any blame. However, security is all about reducing surface area and risk. Treat your customer data as if it’s your own and help them by adding guards that prevent accidental key exposure.

How to prevent accidental key exposure

The easiest way to prevent key exposure is by leveraging two tokens rather than one. A refresh token is stored as an environment variable and can only be used to generate short lived access tokens. Unlike the refresh token, these short lived tokens can access the resources, but are time limited such as in hours or days.

The customer will store the refresh token with other API keys. Then your SDK will generate access tokens on SDK init or when the last access token expires. If a CURL command gets pasted into a GitHub issue, then a hacker would need to use it within hours reducing the attack vector (unless it was the actual refresh token which is low probability)

Exposure to DDoS attacks

APIs open up entirely new business models where customers can access your API platform programmatically. However, this can make DDoS protection tricky. Most DDoS protection is designed to absorb and reject a large number of requests from bad actors during DDoS attacks but still need to let the good ones through. This requires fingerprinting the HTTP requests to check against what looks like bot traffic. This is much harder for API products as all traffic looks like bot traffic and is not coming from a browser where things like cookies are present.

Stopping DDoS attacks

The magical part about APIs is almost every access requires an API Key. If a request doesn’t have an API key, you can automatically reject it which is lightweight on your servers (Ensure authentication is short circuited very early before later middleware like request JSON parsing). So then how do you handle authenticated requests? The easiest is to leverage rate limit counters for each API key such as to handle X requests per minute and reject those above the threshold with a 429 HTTP response. There are a variety of algorithms to do this such as leaky bucket and fixed window counters.

Incorrect server security

APIs are no different than web servers when it comes to good server hygiene. Data can be leaked due to misconfigured SSL certificate or allowing non-HTTPS traffic. For modern applications, there is very little reason to accept non-HTTPS requests, but a customer could mistakenly issue a non HTTP request from their application or CURL exposing the API key. APIs do not have the protection of a browser so things like HSTS or redirect to HTTPS offer no protection.

How to ensure proper SSL

Test your SSL implementation over at Qualys SSL Test or similar tool. You should also block all non-HTTP requests which can be done within your load balancer. You should also remove any HTTP headers scrub any error messages that leak implementation details. If your API is used only by your own apps or can only be accessed server-side, then review Authoritative guide to Cross-Origin Resource Sharing for REST APIs

Incorrect caching headers

APIs provide access to dynamic data that’s scoped to each API key. Any caching implementation should have the ability to scope to an API key to prevent cross-pollution. Even if you don’t cache anything in your infrastructure, you could expose your customers to security holes. If a customer with a proxy server was using multiple API keys such as one for development and one for production, then they could see cross-pollinated data.

#api management #api security #api best practices #api providers #security analytics #api management policies #api access tokens #api access #api security risks #api access keys