Readme

Readme là một nền tảng cho phép bạn tạo và xuất bản tài liệu tương tác dành cho nhà phát triển về các API của bạn. Khác với các công cụ tài liệu truyền thống, Readme tự động tạo các tham chiếu API từ các tệp OpenAPI hoặc Swagger của bạn và giữ mọi thứ đồng bộ với mã nguồn của bạn.

Nền tảng bao gồm một trình soạn thảo tích hợp nơi bạn có thể viết hướng dẫn, thêm ví dụ mã và giải thích cách API của bạn hoạt động. Các nhà phát triển sử dụng API của bạn có thể thử nghiệm các điểm cuối trực tiếp từ tài liệu với tính năng Thử Ngay, giúp họ dễ dàng hiểu cách mọi thứ hoạt động.

Readme cũng cung cấp phân tích để bạn có thể xem phần nào trong tài liệu của bạn được xem nhiều nhất và nơi các nhà phát triển có thể gặp khó khăn, giúp bạn cải thiện trải nghiệm API theo thời gian.

Bắt đầu với Readme rất đơn giản và dễ dàng. Dưới đây là các bước chính:

• Đăng ký tài khoản miễn phí trên trang web Readme và tạo dự án đầu tiên của bạn với tên và URL tùy chỉnh.

• Kết nối tệp OpenAPI hoặc Swagger của bạn để tự động tạo tài liệu tham khảo API, hoặc sử dụng trình chỉnh sửa thủ công để ghi chép từng điểm cuối một.

• Sử dụng trình chỉnh sửa markdown để tạo hướng dẫn, bài học và bài viết trợ giúp. Bạn có thể thêm khối mã, hình ảnh và video để làm nội dung hữu ích hơn.

• Tùy chỉnh giao diện tài liệu của bạn bằng cách chọn chủ đề, màu sắc và thêm logo công ty để phù hợp với thương hiệu của bạn.

• Thiết lập xác thực để các nhà phát triển có thể thử nghiệm API trực tiếp từ tài liệu bằng khóa API của riêng họ.

• Xuất bản tài liệu của bạn và chia sẻ liên kết với cộng đồng nhà phát triển.

• Giám sát cách các nhà phát triển sử dụng tài liệu của bạn với bảng điều khiển phân tích tích hợp để xem các trang phổ biến và các vấn đề thường gặp.

• Tham chiếu API tương tác với chức năng Thử ngay

• Đồng bộ tệp OpenAPI và Swagger

• Trình soạn thảo Markdown cho hướng dẫn và bài học

• Quản lý nhiều phiên bản API

• Tên miền tùy chỉnh và thương hiệu trắng

• Phân tích thời gian thực và theo dõi sử dụng

• Hợp tác nhóm với đánh giá và phân nhánh

• Nhật ký thay đổi và diễn đàn thảo luận

• SSO và bảo mật nâng cao

• Công cụ tài liệu hỗ trợ AI

• Thiết kế đáp ứng trên di động