
Security News
vlt Launches "reproduce": A New Tool Challenging the Limits of Package Provenance
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.
An MkDocs plugin to generate a markdown file containing an API reference built using Swagger UI from a base OAS3 specification.
A MkDocs plugin created to help developer embed API Reference documentation into a mkdocs powered website.
The output file can be modified by editing a template file.
Install the plugin using pip:
pip install mkdocs-swagger-ui
Activate the plugin in mkdocs.yml
:
plugins:
- swagger-ui:
spec_url: 'https://netstorage.ringcentral.com/dpw/api-reference/specs/rc-platform.yml'
outfile: 'docs/api.md'
Add the CSS file to your mkdocs.yml:
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.43.0/swagger-ui.css
spec_url
: Sets the URL to the Swagger specification for the RingCentral platform. This should default to the official URL. Override this for development purposes only.outfile
: The file to output. This file is typically somewhere in your docs folder.template
: The name of the template file that generates the contents of the Swagger UI generated page. This file should be located in a tmpl
directory.More information about plugins in the MkDocs documentation.
This plugin works by loading a different template and markdown file that renders a Swagger UI page in a file's place. The key to making this work is to ensure that the outfile
plugin config value matches the filename of some file in your documentation tree, as shown below. When mkdocs encounters this file and if the file matches the outfile
then the plugin will render a Swagger UI in place of whatever file may already be in place. In other words, the contents of the file are completed ignored, and replaced by the output of this plugin.
plugins:
- swagger-ui:
outfile: api/quick-reference.md
pages:
- 'Home': index.md
- 'Quick Reference': api/quick-reference.md
More information about templates here.
More information about blocks here.
FAQs
An MkDocs plugin to generate a markdown file containing an API reference built using Swagger UI from a base OAS3 specification.
We found that mkdocs-swagger-ui demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.
Research
Security News
Socket researchers uncovered a malicious PyPI package exploiting Deezer’s API to enable coordinated music piracy through API abuse and C2 server control.
Research
The Socket Research Team discovered a malicious npm package, '@ton-wallet/create', stealing cryptocurrency wallet keys from developers and users in the TON ecosystem.