Docs: Add information on the default OpenAPI files available · litestar-org/litestar#3941

(3 评论) (0 反应) (0 负责人)Python (8,243 star) (550 fork)user submission

Documentation :books:Good First IssueHelp Wanted :sos:

描述

Summary

In https://docs.litestar.dev/latest/usage/openapi we don't really specifically say anything about the availability of $openapi_path/openapi.{json,yaml,yml} except in 2 places, 1 of which says it is deprecated:

https://docs.litestar.dev/latest/usage/openapi/ui_plugins.html#providing-a-subclass-of-openapicontroller (but just glossing over)
https://docs.litestar.dev/latest/usage/openapi/ui_plugins.html#configuring-the-openapi-root-path (but just glossing over)

It would be nice to document this when people need them e.g., for Scalar API client's collection import feature

贡献者指南

技术栈: pythonrest api
领域: documentation
议题类型: documentation
难度: 2
预计时间: under 1 hour
活动状态: fresh
清晰度: clear
前置要求: Familiarity with Litestar frameworkKnowledge of OpenAPI
新手友好度: 90
研究方向: Examine the two referenced documentation pages and the OpenAPI controller implementation to understand how the default files are served. Then add a clear section in the OpenAPI usage documentation that explicitly mentions the availability of openapi.json, openapi.yaml, and openapi.yml at the configured OpenAPI path. Consider including a note for Scalar API client's collection import feature.