Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Ensembl
- Người viết nội dung kỹ thuật:
- laurelm
- Tên dự án:
- Tài liệu về API REST
- Độ dài dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Cải thiện hướng dẫn sử dụng dành cho nhà phát triển về cách sử dụng API Ensembl REST
Trọng tâm chính – Cung cấp phần giới thiệu/bắt đầu thân thiện hơn với người dùng.
Phương thức triển khai đề xuất dựa trên các trang tài liệu sau:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Trang chính:
Bao gồm các phần sau (xem ở cấp cao):
Tổng quan về những gì API này cung cấp trên thực tế
Giới thiệu ngắn về REST
Một ví dụ nhanh
Thông tin xác thực
Giới thiệu về cách cấu trúc URL bằng các phương thức HTTP khác nhau
Thông tin về các tham số bắt buộc và không bắt buộc cũng như vị trí của các tham số đó trong tài liệu về điểm cuối được tạo tự động.
Đường liên kết đến trang đào tạo sau: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Thông tin về các hàm trợ giúp được sử dụng trong khoá đào tạo
Các trang tiếp theo
Tuỳ thuộc vào độ phức tạp của các chủ đề được liệt kê trong trang chính, một số chủ đề có thể cần liên kết đến các trang chi tiết tiếp theo.