Improve auto-generated OpenAPI docs - Githubissues

WinterFramework / winter

Web Framework with focus on python typing, dataclasses and modular design

MIT License

17 stars 18 forks source link

Improve auto-generated OpenAPI docs #245

Closed iisaev-qs closed 1 year ago

iisaev-qs commented 1 year ago

We need to update Winter framework to generate more detailed OpenAPI docs descriptions. Here is what we need to add:

multiline docstrings for methods that represent API endpoints (currently only the first line of the docstring is being processed as a description)
docstrings for DTO-classes that represent request/response payload and exceptions
docstrings for members (attributes) of DTO-classes that represent request/response payload

We need this three options to appear in the OpenAPI specification that is generated by Winter.

khudyakoff commented 1 year ago

🔥