Để biết danh sách đầy đủ các chú thích được hỗ trợ, vui lòng xem không gian tên
composer global require zircote/swagger-php3 hoặc trang web tài liệu
Đặc trưng
- Tương thích với OpenAPI 3. 0 và 3. 1 đặc điểm kỹ thuật
- Trích xuất thông tin từ mã và các chú thích phpdoc hiện có
- Giao diện dòng lệnh có sẵn
- Trang web tài liệu với hướng dẫn bắt đầu
- Báo cáo lỗi đặc biệt [có gợi ý, ngữ cảnh]
- Kể từ PHP 8. 1 tất cả các chú thích cũng có sẵn dưới dạng thuộc tính PHP
Hỗ trợ phiên bản OpenAPI
composer global require zircote/swagger-php4 cho phép tạo thông số kỹ thuật cho OpenAPI 3. 0. 0 hoặc OpenAPI 3. 1. 0. Theo mặc định, thông số kỹ thuật sẽ ở phiên bản
composer global require zircote/swagger-php5. Tùy chọn dòng lệnh
composer global require zircote/swagger-php6 có thể được sử dụng để thay đổi điều này thành
composer global require zircote/swagger-php7
Về mặt lập trình, phương pháp
composer global require zircote/swagger-php8 có thể được sử dụng để thay đổi phiên bản
Yêu cầu
composer global require zircote/swagger-php4 yêu cầu ít nhất PHP 7. 2 cho chú thích và PHP 8. 1 để sử dụng các thuộc tính
Cài đặt [với Composer]
composer require zircote/swagger-php
Để sử dụng cli từ mọi nơi, hãy cài đặt swagger-php trên toàn cầu và đảm bảo đặt thư mục
/** * @OA\Info[title="My First API", version="0.1"] */ /** * @OA\Get[ * path="/api/resource.json", * @OA\Response[response="200", description="An example resource"] * ] */0 trong PATH của bạn để hệ thống của bạn có thể định vị tệp thực thi
/** * @OA\Info[title="My First API", version="0.1"] */ /** * @OA\Get[ * path="/api/resource.json", * @OA\Response[response="200", description="An example resource"] * ] */1
composer global require zircote/swagger-php
Cách sử dụng
Thêm chú thích vào tệp php của bạn
Truy cập trang web Tài liệu để biết hướng dẫn Bắt đầu hoặc xem thư mục Ví dụ để biết thêm ví dụ
Cách sử dụng từ php
Tạo tài liệu luôn cập nhật
toYaml[];
Tài liệu về cách sử dụng lớp
/** * @OA\Info[title="My First API", version="0.1"] */ /** * @OA\Get[ * path="/api/resource.json", * @OA\Response[response="200", description="An example resource"] * ] */2 có thể được tìm thấy trong tài liệu tham khảo Generator
Cách sử dụng từ Giao diện dòng lệnh
Giao diện dòng lệnh
/** * @OA\Info[title="My First API", version="0.1"] */ /** * @OA\Get[ * path="/api/resource.json", * @OA\Response[response="200", description="An example resource"] * ] */1 có thể được sử dụng để tạo tài liệu thành tệp yaml/json tĩnh
./vendor/bin/openapi --help
Bắt đầu với phiên bản 4, bộ phân tích mặc định được sử dụng trên dòng lệnh là
/** * @OA\Info[title="My First API", version="0.1"] */ /** * @OA\Get[ * path="/api/resource.json", * @OA\Response[response="200", description="An example resource"] * ] */4 mới
Sử dụng cờ
/** * @OA\Info[title="My First API", version="0.1"] */ /** * @OA\Get[ * path="/api/resource.json", * @OA\Response[response="200", description="An example resource"] * ] */5 [_______8_______6] vẫn có thể sử dụng cờ kế thừa
/** * @OA\Info[title="My First API", version="0.1"] */ /** * @OA\Get[ * path="/api/resource.json", * @OA\Response[response="200", description="An example resource"] * ] */7
Cách sử dụng từ Deserializer
Tạo đối tượng chú thích OpenApi từ chuỗi json, giúp dễ dàng thao tác với các đối tượng theo lập trình hơn
Đơn giản hóa việc phát triển API cho người dùng, nhóm và doanh nghiệp với bộ công cụ chuyên nghiệp và mã nguồn mở Swagger. Tìm hiểu cách Swagger có thể giúp bạn thiết kế và ghi lại các API của mình trên quy mô lớn. Sức mạnh của các công cụ Swagger bắt đầu với Đặc tả OpenAPI — tiêu chuẩn ngành cho RESTful APIXem phần mềm
Mất ngủ
Thiết kế, gỡ lỗi và kiểm tra API như con người, không phải robot. Cuối cùng, quy trình làm việc mà bạn sẽ yêu thích. Công cụ thiết kế API cộng tác để thiết kế, thử nghiệm và quản lý các thông số kỹ thuật của OpenAPI. Máy khách API máy tính để bàn cho REST và GraphQL. Đưa ra yêu cầu, kiểm tra phản hồi. Nhanh chóng tạo và nhóm các yêu cầu,
Xem phần mềm
Xưởng API RepreZen
Xây dựng API nhấp với ứng dụng khách. RepreZen API Studio là một bàn làm việc tích hợp tập trung vào thiết kế ưu tiên API cho toàn bộ nhóm của bạn, hài hòa các thiết kế API của bạn và tạo các API nhấp vào ứng dụng khách. dễ dàng. Trình chỉnh sửa OpenAPI đầy đủ tính năng với hỗ trợ nội dung,