Stridegen is a Swagger documentation generator. Similar to the https://github.com/swagger-api/swagger-ui project, Stridegen will, given an input Swagger 2.x definition output a static web page.
Stridegen is written in React + Sass, and uses Webpack to build and output HTML.
See the live example, automatically built from the master branch.
Currently, Stridegen will only run on OSX / Linux environments. It can be run on Windows machines as well, however at this time the project must be installed manually - see the Development section.
To install or update Stridegen, grab it from the npm repository,
npm install -g stridegen
Then, to generate documentation, run stridegen and give it an input Swagger definition and output directory.
stridegen -f <swagger_definition>.json -o <output_dir>
Open up <output_dir>/index.html in the browser of your choice.
Click here to download a sample Swagger definition file.
To develop Stridegen, or manually build documentation if using Windows first clone and install dependencies.
git clone https://github.com/psastras/stridegen.git
cd stridegen
npm install
To start the development server (which will automatically hot reload changes) run
npm run start
And then navigate to http://localhost:3000/.
To run tests,
npm run test
To build documentation / distribution pages (ie. if on Windows),
npm run build
MIT license. Copyright © 2016, Paul Sastrasinh. All rights reserved.
FAQs
Swagger documentation generation.
The npm package stridegen receives a total of 13 weekly downloads. As such, stridegen popularity was classified as not popular.
We found that stridegen demonstrated a not healthy version release cadence and project activity because the last version was released 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
OpenAI rotated macOS signing certificates after a malicious Axios package reached its CI pipeline in a broader software supply chain attack.
Security News
Open source is under attack because of how much value it creates. It has been the foundation of every major software innovation for the last three decades. This is not the time to walk away from it.
Security News
Socket CEO Feross Aboukhadijeh breaks down how North Korea hijacked Axios and what it means for the future of software supply chain security.