Dự án Ensembl
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
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.
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2024-11-08 UTC.
[[["Dễ hiểu","easyToUnderstand","thumb-up"],["Giúp tôi giải quyết được vấn đề","solvedMyProblem","thumb-up"],["Khác","otherUp","thumb-up"]],[["Thiếu thông tin tôi cần","missingTheInformationINeed","thumb-down"],["Quá phức tạp/quá nhiều bước","tooComplicatedTooManySteps","thumb-down"],["Đã lỗi thời","outOfDate","thumb-down"],["Vấn đề về bản dịch","translationIssue","thumb-down"],["Vấn đề về mẫu/mã","samplesCodeIssue","thumb-down"],["Khác","otherDown","thumb-down"]],["Cập nhật lần gần đây nhất: 2024-11-08 UTC."],[[["This project focuses on improving the Ensembl REST API documentation, specifically the introductory and getting started sections, to make it more user-friendly for developers."],["The documentation will include an overview of the API's functionality, a brief introduction to REST, a practical example, authentication details, URL structure explanation, and information about parameters and the Ensembl training course."],["Certain complex topics may have dedicated detailed pages linked from the main documentation page for comprehensive understanding."],["This is a Google Season of Docs project, with Ensembl as the open-source organization and laurelm as the technical writer, lasting for three months."]]],["The core of this project is to improve the Ensembl REST API developer user guide. Key actions include creating a user-friendly introduction, covering REST API basics, authentication, URL structure, and parameter usage. The main page will provide an overview, a quick example, and links to training and helper functions. Depending on the complexity, subsequent pages with detailed explanations may be necessary. The project will use Google's documentation as a model.\n"]]
