Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
grand-swagger
Advanced tools
A grandjs helper package for generating swagger documentation from json
A grandjs helper package for generating swagger documentation from json
About Installing Usage Example Render Swagger Component
This package is developed for grandjs framework to allow you write swagger documentation for your Grandjs Application!
Tou Install Grand-swagger you just need to write the following command!
npm i grand-swagger
Grand Swagger exposed to you a simple jsx component that you can use to render your swagger documentation easily!
import {SwaggerComponent} from "grand-swagger";
To render Grand Swagger Component you can define a new route and in the handler you can use res.render
to render this component, this component takes the following properties
property | type | required | description |
---|---|---|---|
docs | object | true | this property is an object which implies your swagger documentation that you want to show |
import {Server, Router} from "grandjs"
import {SwaggerComponent} from "grand-swagger";
import docs from "./doc.json";
class MainRouter extends Router{}
const mainRouter = new MainRouter({base: "/"});
mainRouter.addRoute({
url: "/docs",
method: "GET",
handler: (req, res) => {
res.render(SwaggerComponent, {docs: docs})
}
})
FAQs
A grandjs helper package for generating swagger documentation from json
The npm package grand-swagger receives a total of 2 weekly downloads. As such, grand-swagger popularity was classified as not popular.
We found that grand-swagger 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.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.