Skip to content
rapi-docPublic

About

PDF generation from OpenAPI / Swagger Spec

Topics

Resources

Stars

308 stars

Watchers

5 watching

Forks

Repository files navigation

MrinDoc logo

RapiPDF

Custom element for Open-API to PDF generation

RapiPdf has moved. Its source is now packages/rapipdf in the RapiDoc repository, released from there to npm as rapipdf (3.x), and its documentation is at rapidocui.com/rapipdf. This repository keeps the 2.x history; new issues and pull requests go to rapi-doc/RapiDoc.

Features

  • Supports Swagger 2.0 and OpenAPI 3.0
  • Generate PDF using Web-Component
  • Works with any framework or with no framework
  • Plenty of customizing options, including selection of brand colors
  • Supported on Chrome, FireFox and Safari. (Not yet tested on Edge)

Documentation

Usage, a live demo and the API reference

Build Process

We recommend yarn over npm as we use yarn resolutions to keep the bundle size smaller. As of this writing this feature is not supported in npm natively

# Clone / Download the project then
yarn install

# build will generate rapidoc-min.js, this is the only file you will need.
# use it in the script tag of your html <script type="text/javascript" src="rapidoc-min.js"></script></body>
yarn build

# for developement use yarn serve (this will start an webserver at port 8080, then navigate to localhost:8080)
yarn serve

# alternative to yarn serve: (this will start an webserver at port 8080 listening to all adapters)
yarn serve-everyone

About

PDF generation from OpenAPI / Swagger Spec

Topics

Resources

Stars

308 stars

Watchers

5 watching

Forks

Releases

Packages

Used by

Contributors

Languages