fastapi
fastapi copied to clipboard
tiangolo
Add Stoplight Elements as built-in docs tool
New way to document the API using Stoplight Elements. https://stoplight.io/open-source/elements
The user will be able to use all of the featuers that this product offers.(https://meta.stoplight.io/docs/elements/b074dc47b2826-elements-configuration-options)
This PR includes a custom function that is equivalent to get_swagger_ui_html and redoc_html.
Also there is an option to set the path of the docs from the constructor of the app just like docs_url and redoc_url
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Comparison is base (
cf73051) 100.00% compared to head (5ac4a30) 100.00%. Report is 1038 commits behind head on master.
:exclamation: Current head 5ac4a30 differs from pull request most recent head 0c4a71d. Consider uploading reports for the commit 0c4a71d to get more accurate results
Additional details and impacted files
@@ Coverage Diff @@
## master #5168 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 540 538 -2
Lines 13969 13894 -75
=========================================
- Hits 13969 13894 -75
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
![codecov[bot] avatar](https://avatars.githubusercontent.com/in/254?v=4 "Published by a pub.dev verified publisher"){kind=small}
📝 Docs preview for commit 1070fee541b50e29be1268a637e7e494d0bde14f at: https://62d5bfe0ec4981009ec2a225--fastapi.netlify.app
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
📝 Docs preview for commit 901639098b8e4176e194f173990ab97c45e905b4 at: https://62d5c4a1f505040d1d4ef659--fastapi.netlify.app
📝 Docs preview for commit 703499e940e2da821a53d32ddbcd814f71d71d31 at: https://63066d942389381512531ae5--fastapi.netlify.app
📝 Docs preview for commit bbffb0e402a01a011bff9b2cf6535b522e81b470 at: https://63067b643eb725209ea872d1--fastapi.netlify.app
📝 Docs preview for commit b4cd1f2893b9cc018e67050cd39fd0413886f59e at: https://63067f21f758ce00a4671a6a--fastapi.netlify.app
📝 Docs preview for commit 45f749d8277978afac2289d2d0019b6b05adbfe3 at: https://630686c4a566b600ba0cad49--fastapi.netlify.app
Hey!
I have updated the code and added new section to the documentation. I would like you to review the new changes :) @JarroVGIT
📝 Docs preview for commit 5ac4a30577c04844a2432b27b07f57a58e95b5dd at: https://630a063da75f7a6db821c96f--fastapi.netlify.app
Hey! How can I continue the process? Is there an estimated time for merging this PR into the main repository? Is there something else I have missed that needs to be done? @JarroVGIT
Is there an estimated time for merging this PR into the main repository?
Wondering the same :)
📝 Docs preview for commit 18af7a891d1def228dfd5299ba6f6de416747636 at: https://63651a88f1f3d2009cef96ee--fastapi.netlify.app
Very much interested in this feature! =) @tiangolo, do you think it may be released soon?
📝 Docs preview for commit 9ddd736d761a35e464b47565ee28109f4d2aeaf3 at: https://639ce67ce97dd30b19989db7--fastapi.netlify.app
📝 Docs preview for commit 0c4a71d39a5af0eac27a432022ef20c4c841da09 at: https://639dd101c1082f2173d1c692--fastapi.netlify.app
@tiangolo I've fixed the lint error and updated this branch with your master :-)
Is there any word on this? Seems @ShaharIlany's great work is more than ready! =)
redoc if good for API user to get start, but without testing api directly in swagger UI. stoplight elements just get both features. Hope this will be integrated to fastapi soon
