Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần Google Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Kết quả
- Người viết nội dung kỹ thuật:
- laurelm
- Tên dự án:
- Tài liệu về API REST
- Thời lượng dự án:
- Thời gian 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/phần bắt đầu thân thiện hơn với người dùng.
Cách triển khai được đề xuất dựa trên các dòng của 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 mục sau (chế độ xem cấp cao):
Tổng quan về những gì mà API này cung cấp trong thực tế
Giới thiệu ngắn về REST
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 tạo tự động.
Đường liên kết đến trang đào tạo sau đây: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Thông tin về những hàm_trợ_giúp mà bạn 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ê trên 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.