Allow using example response as a response schema

sanic-org / sanic-openapi

Easily document your Sanic API with a UI

https://sanic-openapi.readthedocs.io/

MIT License

505 stars 108 forks source link

Allow using example response as a response schema #169

Closed jkirsteins closed 4 years ago

jkirsteins commented 4 years ago

Quick PoC PR to explore showing example values in Swagger UI.

If given e.g. a dict with actual values (not types) as the response schema, use the types as schema, but use the given values as an example.

Does this approach make sense in general?
If so, is there anything obvious I've overlooked here?

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If this is incorrect, please respond with an update. Thank you for your contributions.