Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Elements, RapiDoc, and RapiPDF #308

Merged
merged 3 commits into from
Jul 1, 2022
Merged

Support Elements, RapiDoc, and RapiPDF #308

merged 3 commits into from
Jul 1, 2022

Conversation

greyli
Copy link
Member

@greyli greyli commented Jun 12, 2022

  • Add support for Elements, RapiDoc, and RapiPDF.
  • Add APIFlask(docs_ui) parameter to control the UI to use.
  • Deprecate /redoc path and redoc_path parameter.
from apiflask import APIFlask

app = APIFlask(__name__, docs_ui='redoc')

Checklist:

  • Add tests that demonstrate the correct behavior of the change. Tests should fail without the change.
  • Add or update relevant docs, in the docs folder and in code docstring.
  • Add an entry in CHANGES.md summarizing the change and linking to the issue and your username.
  • Add *Version changed* or *Version added* note in any relevant docs and docstring.
  • Run pytest and tox, no tests failed.

- Add support for Elements, RapiDoc, and RapiPDF.
- Add APIFlask(docs_ui) parameter to control the UI to use.
- Deprecate `/redoc` path and `redoc_path` parameter.
@greyli greyli mentioned this pull request Jun 30, 2022
@greyli greyli marked this pull request as ready for review June 30, 2022 15:47
@greyli greyli merged commit 92b0690 into main Jul 1, 2022
@greyli greyli deleted the docs-ui branch July 1, 2022 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support elements API docs Support RapiDoc and RapiPDF
1 participant