docu-generator
Advanced tools
## What is API DocuGenerator? The API DocuGenerator Library works by dynamically producing HTML based on your web API's [Open API spec](), visually representing your API's endpoints in your own customized design and layout while retaining the operational
Readme
The API DocuGenerator Library works by dynamically producing HTML based on your web API's Open API spec, visually representing your API's endpoints in your own customized design and layout while retaining the operational efficiencies and interactivity of Swagger docs.
We help API developers and technical writers already leveraging Swagger and the Open API spec to generate 'try-it-out' docs, but who feel limited by the variety of visual outputs available through Swagger.
With our library, you can can wire up your own doc sites The beauty of the API DocuGenerator is the ability to wire up your current doc sites to dynamically update whenever your API updates.
(no matter which JS framework - must be ES6/ES2015+) You may already has a branded template, and they just need it to dynamically update based on changes to the API. They realize that creating a custom solution would be expensive, time consuming, and difficult to maintain.
docu-generator node packageWhile the docu-generator library is compatible with virtually all JavaScript projects, the library must be installed via npm.
To install the docu-generator library in the node_modules folder of your project, execute this npm command in your project's top-level folder:
npm install docu-generator --registry=https://registry.npmjs.org/
The docu-generator is succesfully installed.
In index.html or any HTML file (or Markdown file that will be compiled into HTML) that will contibrute to the content of the DOM, insert a div element with an id of docu-generator-template.
<div id="docu-generator-template"></div>
The library will dynamically populate children into this element that document your web API's Open API Spec.
In the head element of index.html:
<head>
<link rel="stylesheet" href="docu-generator.css" />
</head>
Or if you are using Angular, import it at the top of your application's primary global SCSS stylesheet.
@import "~docu-generator/docu-generator.css";
OR
Register it in angular.json under projects > {application name} > architect > build > styles as a global style sheet for your project. (This is a good alternative if your application's primary global stylesheet is CSS.)
"styles": ["./src/styles.css", "./node_modules/docu-generator/docu-generator.css"]
Or import the stylehseet in a manner that is compatible with you preferred JavaScript development framework.
docu-generator library with the URL of your web API's Open API spec// Perform an ES6/ES2015 import of the library's generateDocs function at the top of your project's main entrypoint JavaScript file.
import { generateDocs } from "./docu-generator.js";
// Call the function and provide it with a URL that targets a JSON file containing your web API's Open API spec.
generateDocs("http://localhost:5000/swagger/v1/swagger.json");
FAQs
## What is API DocuGenerator? The API DocuGenerator Library works by dynamically producing HTML based on your web API's [Open API spec](), visually representing your API's endpoints in your own customized design and layout while retaining the operational
The npm package docu-generator receives a total of 1 weekly downloads. As such, docu-generator popularity was classified as not popular.
We found that docu-generator 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
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.