Skip to main content
SearchLoginLogin or Signup

Introducing the New ADS OpenAPI Exploration Tool: Making API Access More User-Friendly

Presentation #302.17 in the session Computation, Data Handling, Image Analysis — iPoster Session.

Published onJun 29, 2022
Introducing the New ADS OpenAPI Exploration Tool: Making API Access More User-Friendly

The NASA Astrophysics Data System’s API, or application programming interface, is designed to be easily accessible, allowing users to create their own tools and scripts. However, while our documentation for the API covered the most widely used features, there were a number of useful components that we had not properly documented. We have now remedied this shortcoming by using the OpenAPI specification, a language-agnostic, widely adopted industry standard for documenting APIs in a machine-readable way. This OpenAPI document underlies our new beautiful, easy to use documentation, powered by RapiDoc. In addition to providing a listing of all available API endpoints, the new documentation defines all available inputs and possible API responses, offers examples, and provides further description and explanation as necessary. The most unique feature of the new documentation is the built-in try-me functionality, which allows you to run API queries directly from your browser. This poster spotlights the capabilities of the new documentation and highlights other recent and forthcoming changes to our API documentation.

Comments
0
comment

No comments here