Robyn icon indicating copy to clipboard operation
Robyn copied to clipboard

[Feature Request] Add openapi integration

Open sansyrox opened this issue 3 years ago • 2 comments

Current Behavior

Robyn doesn't generate OpenAPI documentations by default. OpenAPI integration is a highly demanded feature and I am super keen on supporting it.

Desired Behavior

A few good links to have a look at are:

  • https://github.com/marshmallow-code/apispec
  • https://github.com/tiangolo/fastapi/blob/bcabbf8b37db3fbc020560e94ad2f90e64d1510a/fastapi/openapi/docs.py#L1

A high level way of implementing the feature would require:

  • Adding a documentation route(r)
  • Make it configurable
  • Make it adhere to the passed params --dev/--prod
  • Create a class that has OpenAPI pre-requisites (pre-populating-html strings, reponse_parser, etc.)
  • Pass it to the threadpool.

sansyrox avatar Jul 24 '22 13:07 sansyrox

@sansyrox I'm working on this issue 😁, go ahead and assign it to me.

image

Mr-Sunglasses avatar Jul 17 '23 00:07 Mr-Sunglasses

Is there a PR or a draft open for it ?

patrickelectric avatar Aug 21 '23 16:08 patrickelectric