tensei icon indicating copy to clipboard operation
tensei copied to clipboard

OpenAPI Specification Endpoint

Open tobius opened this issue 3 years ago • 2 comments

Feature request

Represent the current configured API as an OpenAPI specification endpoint.

Why is it needed?

By auto generating an OpenAPI specification from the configured API choices Tensei will achieve several new capabilities:

  1. Any API Developer who understands OpenAPI specifications can use it to learn the API.
  2. Most automated API consumption tools that exist today understand OpenAPI and can use it to parse the API structure.
  3. Automated API documentation generation tools like (e.g. RapiDoc) could be used to add an automated documentation endpoint to Tensei.

References:

Suggested solution(s)

I want the current configured API to be represented as an OpenAPI specification endpoint.

tobius avatar Oct 22 '21 15:10 tobius

Heey thanks for sharing .Great idea. This is not something I'll focus on at the moment, but it's definitely on the roadmap for later. Once we have good documentation on how to contribute I'll share here in case you want to. Thanks !

bahdcoder avatar Oct 22 '21 15:10 bahdcoder

Please do! I'm considering your framework for some of my future projects and I'd be happy to contribute.

tobius avatar Oct 22 '21 15:10 tobius