docu-generator
v0.0.1-alpha
Published
## 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
Downloads
7
Readme
API DocuGenerator Overview
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 efficiencies and interactivity of Swagger docs.
Who is it for?
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.
Getting Started
Step 1: Install docu-generator node package
While 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.
Step 2: Select documentation insertion point in HTML
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.
Step 3: Import library stylesheet
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.
Step 4: Supply the 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");