tap-rest-api icon indicating copy to clipboard operation
tap-rest-api copied to clipboard

OpenAPI specification input

Open james-blitzm opened this issue 3 years ago • 2 comments

This project seems like a good candidate to implement using an OpenAPI-standard specification as an input schema for generation of Singer models.

i.e. Taking the JSON generation one step further to make use of an officially published OpenAPI specification for the target source API.

For example, here is the official OpenAPI specification for the Stripe API v3: https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.yaml

james-blitzm avatar Jun 13 '21 14:06 james-blitzm

Hi @james-blitzm

This is a great idea and is well-aligned with what I want to build in the major update of tap-rest-api. This project's renewed goal is to create as versatile tap as possible, leveraging standardization such as Open API. The next update is a major rewrite incorporating the enhancement such as

  • #5
  • #11
  • #18 I will consider your suggestion as one of the top priorities in the release.

Thanks again.

daigotanaka avatar Jun 13 '21 16:06 daigotanaka

Pagination might be tricky as OpenAPI isn't prescriptive on how this should be implemented. You will need to ensure the developer has the ability to define the pagination model some how.

james-blitzm avatar Jun 14 '21 11:06 james-blitzm