GA4GH数据对象服务架构
ga4gh-dos-schemas的Python项目详细描述
数据对象服务(DOS)API的模式
View the schemas in Swagger UI
< DOS的目标是在现有对象存储系统之上创建通用API。 因此,工作流系统可以以一种单一的、标准的方式访问数据,而不管它在哪里 存储。它由GA4GH Cloud Workstream维护。主要功能
API分为两部分:
- 数据对象管理,它支持创建、更新、删除、版本控制, 文件和数据包的唯一标识(文件的平面集合);以及
- 数据对象查询,它可以跨不同的云环境定位数据对象 和dos实现。
开始
安装非常简单:
$ pip install ga4gh-dos-schemas
这将安装一个演示服务器和一个python客户机,允许您
管理本地服务器中的数据对象。您可以使用ga4gh_dos_server
启动演示服务器。
这将在http://localhost:8080启动数据对象服务。
wget http://hgdownload.cse.ucsc.edu/goldenPath/hg38/chromosomes/chr22.fa.gz
md5sum chr22.fa.gz
# 41b47ce1cc21b558409c19b892e1c0d1 chr22.fa.gz
curl -X POST -H 'Content-Type: application/json' \
--data '{"data_object":
{"id": "hg38-chr22",
"name": "Human Reference Chromosome 22",
"checksums": [{"checksum": "41b47ce1cc21b558409c19b892e1c0d1", "type": "md5"}],
"urls": [{"url": "http://hgdownload.cse.ucsc.edu/goldenPath/hg38/chromosomes/chr22.fa.gz"}],
"size": "12255678"}}' http://localhost:8080/ga4gh/dos/v1/dataobjects
# We can then get the newly created Data Object by id
curl http://localhost:8080/ga4gh/dos/v1/dataobjects/hg38-chr22
# Or by checksum!
curl -X GET http://localhost:8080/ga4gh/dos/v1/dataobjects -d checksum=41b47ce1cc21b558409c19b892e1c0d1
有关开始的更多信息,请查看 quickstart guide 或者ReadtheDocs上的其他文档!
参与其中!
数据对象服务模式是apache 2许可的开源软件。请加入我们 在issues中或签出 贡献文档!