ReadMe · Developer-friendly API documentation, for Dataverse! OpenAPI

[Philip Durbin]

Hi! Jan Range set up https://test-dv.readme.io a long time ago, but I don't think we ever announced it. And it has "test" in the name. It's obviously an experiment, but we love experiments, right?

What is it? Well, it's API documentation that's programmatically generated from an OpenAPI document. For us this means https://demo.dataverse.org/openapi or https://beta.dataverse.org/openapi etc.

I just had a need to hit an API endpoint and was about to write a script but remembered Jan showing us the "try it" button during this week's pyDataverse meeting[1].

It worked great! I wanted to compare API output of the demo server vs. the beta server. You can easily just change the hostname and enter your API token. I'll attach some screenshots.

Jan just rebuilt the ReadMe site because Balázs Pataki recently contributed a lot more detail to Dataverse's OpenAPI document in https://github.com/IQSS/dataverse/pull/12439 . That means the ReadMe site has more detail now, since it consumes that OpenAPI document.

Obviously, we should find a more permanent home for the ReadMe site, but since it was already immediately useful to me as-is today, I thought I'd tell you all about it.

You can read more about ReadMe the company and product at https://readme.com . As far as I understand, the product is not open source but it's free for open source projects to use.

To join the discussion in the Dataverse Zulip: #docs > API docs from OpenAPI

I think that's it. Phew! Enjoy!

Thanks,

Phil

1. https://groups.google.com/g/dataverse-community/c/vd5Qj73OfSQ/m/cVj2fdFDAQAJ

--

Philip Durbin
Software Developer for http://dataverse.org
http://www.iq.harvard.edu/people/philip-durbin