Swagger cho tài liệu API

Swagger là một khung phần mềm nguồn mở giúp các nhà phát triển thiết kế, xây dựng, lập tài liệu và sử dụng các API RESTful. Tài liệu về Swagger là một đại diện của API RESTful được tạo bằng đặc tả Swagger. Đặc tả Swagger là ngôn ngữ mô tả giao diện tiêu chuẩn cho API REST. Nó cho phép các nhà phát triển mô tả cấu trúc API của họ và tạo tài liệu ở định dạng mà con người có thể đọc được. Tài liệu về Swagger đã tạo bao gồm thông tin về các điểm cuối API, thông số yêu cầu và phản hồi cũng như các chi tiết liên quan khác. Nó có thể được các nhà phát triển khác sử dụng để hiểu chức năng của API và thực hiện lệnh gọi tới nó.

tính năng vênh vang

Tài liệu về Swagger cung cấp một số tính năng, bao gồm:

1. Tài liệu tương tác: Cho phép nhà phát triển dùng thử lệnh gọi API và xem phản hồi trong giao diện người dùng dựa trên trình duyệt.
2. Định nghĩa API: Cung cấp định nghĩa rõ ràng, ngắn gọn và thân thiện với con người về chức năng của API, điểm cuối, thông số và phản hồi dự kiến.
3. Tạo mã: Tạo mã máy chủ và máy khách bằng nhiều ngôn ngữ lập trình để giúp tăng tốc quá trình phát triển.
4. Xác thực: Tự động xác thực các yêu cầu và phản hồi API để đảm bảo chúng đáp ứng thông số kỹ thuật của API.
5. Tạo tài liệu: Tự động tạo tài liệu API ở nhiều định dạng khác nhau, bao gồm HTML, JSON và YAML.
6. Cộng tác: Hỗ trợ cộng tác giữa người tạo API, nhà phát triển và các bên liên quan bằng cách cung cấp một vị trí tập trung cho tài liệu API.
7. Thử nghiệm: Cung cấp môi trường để thử nghiệm lệnh gọi API và đảm bảo rằng chúng đáp ứng hành vi mong muốn.
8. Lập phiên bản: Hỗ trợ lập phiên bản API và cho phép người dùng xem và làm việc với nhiều phiên bản API.

Tài liệu về Swagger hỗ trợ một số ngôn ngữ lập trình bao gồm:

1. Java
2. Node.js
3. PHP
4. con trăn
5. hồng ngọc
6. Đi
7. C#
8. Scala
9. perl

Bật Swagger trong Spring boot

Để bật tài liệu Swagger trong ứng dụng khởi động mùa xuân, bạn cần làm theo các bước sau:

1. Thêm các phụ thuộc springfox-swagger2 và springfox-swagger-ui vào dự án.
2. Kích hoạt hỗ trợ Swagger trong ứng dụng Spring Boot của bạn bằng cách chú thích lớp cấu hình của bạn với @EnableSwagger2.
3. Tạo một Docket bean để định cấu hình các thuộc tính Swagger, chẳng hạn như phiên bản API, tiêu đề và mô tả.
4. Chú thích các API RESTful của bạn bằng các chú thích Swagger thích hợp, chẳng hạn như @Api, @ApiOperation, @ApiParam, v.v.
5. Chạy ứng dụng Spring Boot và truy cập Swagger UI tại URLhttp://localhost:port/swagger-ui.html, trong đó cổng là cổng HTTP mà ứng dụng của bạn đang chạy trên đó.

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

Thiết lập Swagger 2 với Spring REST API | Baeldung

Lập tài liệu API Spring REST bằng OpenAPI 3.0 | Baeldung