Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenAPI Specification Endpoint #161

Open
tobius opened this issue Oct 22, 2021 · 2 comments
Open

OpenAPI Specification Endpoint #161

tobius opened this issue Oct 22, 2021 · 2 comments

Comments

@tobius
Copy link

tobius commented Oct 22, 2021

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.

@bahdcoder
Copy link
Member

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 !

@tobius
Copy link
Author

tobius commented Oct 22, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants