Render HTTP docs in page #152
Conversation
sindrehan
force-pushed
the
inline-http-docs
branch
from
5d71812 to
dfa09da
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #152 +/- ##
==========================================
+ Coverage 76.37% 76.50% +0.12%
==========================================
Files 11 11
Lines 1672 1664 -8
==========================================
- Hits 1277 1273 -4
+ Misses 395 391 -4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Figured out how to use the render_swagger plugin to show the output from redoc Pretty sure that's fixable with some css/js magic. Here's an example of a dark mode for redoc, redark |
sindrehan
force-pushed
the
inline-http-docs
branch
from
e039331 to
ef54904
Compare
|
I came across this plugin for mkdocs: Might be a better approach than trying to inline the redoc output. |
|
Great work @sindrehan 🙌 |
sindrehan
force-pushed
the
inline-http-docs
branch
from
ef54904 to
011d942
Compare
|
I have two PRs open to add custom templates (Neoteroi/essentials-openapi#61 / Neoteroi/mkdocs-plugins#78), but with those implemented rendering the openapi docs works quite well. 
|
Has better support for nesting, and is set to replace to current syntax at some point.
Uses a markdown table instead of the html table in the original template, this ensures that the markdown in the descriptions is rendered.
For some reason the second instance was not being dereferenced in the request body, so doing it manually instead.
This way
instead of this way
Some considerations: