broadinstitute / gdctools

Python and UNIX CLI utilities to simplify interaction with the NIH/NCI Genomics Data Commons
Other
31 stars 4 forks source link

investigate whether GDC api spec can be converted to OpenAPI (Swagger2 / YAML) #15

Open noblem opened 7 years ago

noblem commented 7 years ago

In principle we could leverage the FireBrowse API generator to automatically fabricate low-level bindings for the entire GDC API ... IF the GDC api could be specified in a manner that the generator reads. The generator currently reads Swagger 1.2, and should be straightforward to upgrade to Swagger 2; and since Swagger 2 is emerging as an open standard in the OpenAPI initiative it would be great to have the GDC api encapsulated in such a specification. Here are some tools that may help in exploring this:

LucyBot This one selects Swagger 2.0 as the OpenAPI standard, accepts multiple forms of input API specs, and converts all of the to Swagger2

ApiMatic This is an online conversion tool which I played with last week to transform our FireBrowse Swagger 1.2 api specification to Swagger 2.0 (and then checked the result into client/api_swag2.yaml of the FireBrowse repo).