search

tenseijs / tensei

🚀 Content management and distribution with a touch of elegance.
https://tenseijs.com
MIT License
569 stars 37 forks source link

OpenAPI Specification Endpoint #161

Open tobius opened 3 years ago

tobius commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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