Web4_Userid Là Gì - Bạn Hiểu Gì Về Công Cụ Viết Document Cho Api

      24
1. OpenAPI là gì

OpenAPI Specification là 1 định hình bộc lộ API giành cho REST APIs. Một file OpenAPI được cho phép bạn diễn tả toàn cục API bao hàm cả

Cho phép số đông endpoints (/web4_users) và phương pháp buổi giao lưu của từng endpoint (GET /web4_users, POST /web4_users)Các tsi số đầu vào & áp ra output của từng hoạt độngPhương thức xác thựctin tức liên lạc, chứng chỉ, luật pháp sử dụng cùng phần lớn công bố khác

API specifications rất có thể được viết bởi YAML hoặc JSON. Định dạng này dễ đọc, dễ hiểu mang đến cả người cần sử dụng lẫn ngôn ngữ máy tính

2. Swagger là gì

Swagger là một bộ vẻ ngoài mã mối cung cấp mnghỉ ngơi nhằm xây dựng OpenAPI specifications giúp chúng ta có thể thiết kế, chế tạo tư liệu và thực hiện REST APIs

3. Cấu trúc cơ bản

3.1: Metadata

Mỗi OpenAPI specifications đã bước đầu với từ khóa openapi để khai báo phiên bạn dạng (VD: openapi: 3.0.0). Phiên phiên bản này đang tư tưởng toàn bộ cấu trúc của APIPhân info đang chứa rất nhiều ban bố của API như: title, desscription (tùy chọn), version

title là tên gọi API của bạndescription là báo cáo không ngừng mở rộng về API của người tiêu dùng. quý khách hàng có thể viết thành nhiều dòng & cung ứng cú pháp Markdowninfo cũng cung cấp các từ bỏ khóa về đọc tin liên hệ, chứng chỉ, quy định áp dụng và đầy đủ ban bố khác

info: title: Sample API description: Optional multiline or single-line description in (http://commonmark.org/help/) or HTML. version: 0.1.9

3.2: Servers

*

Bạn đang xem: Web4_Userid Là Gì - Bạn Hiểu Gì Về Công Cụ Viết Document Cho Api

Tất cả đường truyền API đã là đường truyền tương đối của URL mà chúng ta có mang. Hình ảnh bên yêu cầu là phần UI vẫn hiển thị ra

3.3: Paths

Đây là phần trung tâm của API. Tại phần này bạn sẽ khái niệm hầu như paths vào API của chúng ta tương tự như cách thức, tmê say số vào API

*

Xem thêm: Tra Từ Worm Gear Là Gì - Từ Điển Anh Việt Worm Gear Or Worm Wheel Là Gì

Phần này đã bắt đầu bởi từ bỏ khóa pathsSau đó là tới các path vào API (/web4_user/web4_userId)Tiếp mang lại là cách thức của API (GET, POST, DELETE, PUT ...)summary là phần biểu đạt tóm tắt của APIparameters: đã là rất nhiều tmê say số truyền vào API. Bạn hoàn toàn có thể mix tđắm đuối số required hay là không, trình bày nó (description) hoặc validate. điều đặc biệt vào phần này. bạn cũng có thể hướng dẫn và chỉ định 1 schema (đọc nôm na là một trong Model) để có thể tư tưởng cho chỗ tham số trải qua schema và $refresponse là phần trả về của server. Quý khách hàng hoàn toàn có thể có mang mọi HTTP code: 200, 404, 500 ... cùng với đều biểu lộ mang lại từng trường hợp

3.4: Schema

quý khách rất có thể đọc nôm na đó là 1 Model. Phần này được knhị báo qua trường đoản cú khóa component và schemas (Lưu ý: đa số nơi Gọi mang lại schema này cần chỉ định và hướng dẫn đúng mực đường dẫn VD $ref: "#/components/schemas/User"

*

Tham mê số đầu tiên là tên của Model (User)Tiếp đó sẽ là phần hình trạng định dạng (object)Sau đó là phần ở trong tính của Model này

Trên trên đây mình đã hướng dẫn sơ qua về phần đa chức năng của swagger mà mình đã sử dụng trong dự ánCác chúng ta có thể vào liên kết để có thể viết API một cách luôn tiện duy nhất. Nó đang render UI tức thì lập tức mang đến bạn