Chuyển đến nội dung chính

Azure Functions: Thêm OpenAPI vào Azure Functions - Day 4

OpenAPI là một định dạng mô tả API dành cho các API dựa trên REST. Một file OpenAPI cho phép bạn mô tả toàn bộ API của bạn, bao gồm:

  • Các endpoint (/users) và cách thức hoạt động của mỗi endpoint (GET /users, POST /users).
  • Các parameter đầu vào và đầu ra của từng hoạt động.
  • Phương thức xác thực.
  • ...

OpenAPI và swagger có liên quan chặt chẽ với nhau. OpenAPI là một định dạng mô tả API dành cho các API dựa trên REST. OpenAPI cho phép bạn mô tả các endpoint, phương thức, tham số, phản hồi, kiểu dữ liệu, xác thực và các thông tin khác của API một cách chi tiết và chuẩn xác. Swagger là một bộ công cụ hỗ trợ việc thiết kế, tạo, kiểm tra và tài liệu hóa các API tuân theo định dạng OpenAPI. Swagger bao gồm các công cụ như:

  • Swagger Editor: cho phép bạn chỉnh sửa file OpenAPI bằng YAML trong trình duyệt và xem trước tài liệu một cách động
  • Swagger UI: cho phép bạn hiển thị file OpenAPI dưới dạng tài liệu tương tác trong giao diện người dùng.
  • Swagger Codegen: cho phép bạn sinh ra mã nguồn cho server và client ở nhiều ngôn ngữ lập trình khác nhau từ file OpenAPI.
  • Swagger Inspector: cho phép bạn kiểm tra các API và sinh ra file OpenAPI từ một API hiện có.
  • SwaggerHub: cho phép bạn thiết kế và tài liệu hóa API cho các nhóm làm việc với OpenAPI.

Về cơ bản, bạn có thể hiểu là OpenAPI là đặc tả, còn Swagger là công cụ.

Các bước tạo app chứa Swagger

Để tạo Project Azure Functions, bạn bấm vào biểu tượng Azure Function ở thanh sidebar bên trái

Chọn ngôn ngữ (C#, Typescript...), chọn event cho Function App 


Authorize: chọn Function 

Screenshot for creating function authorization.

Chọn Workspace, tên class Screenshot for selectIng Add to workplace.
Project sẽ được tạo như sau
Trong cửa sổ console sẽ bao gồm
Functions:

        Get: [GET,POST] http://localhost:7071/api/Get

        RenderOAuth2Redirect: [GET] http://localhost:7071/api/oauth2-redirect.html

        RenderOpenApiDocument: [GET] http://localhost:7071/api/openapi/{version}.{extension}

        RenderSwaggerDocument: [GET] http://localhost:7071/api/swagger.{extension}

        RenderSwaggerUI: [GET] http://localhost:7071/api/swagger/ui

Tham khảo

Labels:

Nhận xét

Đăng nhận xét

Bài đăng phổ biến từ blog này

[ASP.NET MVC] Authentication và Authorize

Một trong những vấn đề bảo mật cơ bản nhất là đảm bảo những người dùng hợp lệ truy cập vào hệ thống. ASP.NET đưa ra 2 khái niệm: Authentication và Authorize Authentication xác nhận bạn là ai. Ví dụ: Bạn có thể đăng nhập vào hệ thống bằng username và password hoặc bằng ssh. Authorization xác nhận những gì bạn có thể làm. Ví dụ: Bạn được phép truy cập vào website, đăng thông tin lên diễn đàn nhưng bạn không được phép truy cập vào trang mod và admin.
Đăng nhận xét
Read more »

ASP.NET MVC: Cơ bản về Validation

Validation (chứng thực) là một tính năng quan trọng trong ASP.NET MVC và được phát triển trong một thời gian dài. Validation vắng mặt trong phiên bản đầu tiên của asp.net mvc và thật khó để tích hợp 1 framework validation của một bên thứ 3 vì không có khả năng mở rộng. ASP.NET MVC2 đã hỗ trợ framework validation do Microsoft phát triển, tên là Data Annotations. Và trong phiên bản 3, framework validation đã hỗ trợ tốt hơn việc xác thực phía máy khách, và đây là một xu hướng của việc phát triển ứng dụng web ngày nay.
4 nhận xét
Read more »

Tổng hợp một số kiến thức lập trình về Amibroker

Giới thiệu về Amibroker Amibroker theo developer Tomasz Janeczko được xây dựng dựa trên ngôn ngữ C. Vì vậy bộ code Amibroker Formula Language sử dụng có syntax khá tương đồng với C, ví dụ như câu lệnh #include để import hay cách gói các object, hàm trong các block {} và kết thúc câu lệnh bằng dấu “;”. AFL trong Amibroker là ngôn ngữ xử lý mảng (an array processing language). Nó hoạt động dựa trên các mảng (các dòng/vector) số liệu, khá giống với cách hoạt động của spreadsheet trên excel.
11 nhận xét
Read more »