Skip to content
πŸ€– Generator for OpenAPI repo to help you manage the spec lifecycle
Branch: master
Clone or download
Latest commit fbadb86 Dec 18, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib fix existing schema parsing Dec 8, 2018
template fix .gitignore issue Dec 18, 2018
.eslintrc Fix lint issues Dec 7, 2018
.gitignore initial May 16, 2016
.npmignore fix .gitignore issue Dec 18, 2018
.prettierrc Prettier all Dec 7, 2018
LICENSE initial May 16, 2016
README.md Final fixes Dec 7, 2018
cli.js fix .gitignore issue Dec 18, 2018
live-edit.gif More minor updates Aug 29, 2016
logo.png clean up yeoman references Dec 7, 2018
package-lock.json Update swagger-repo Dec 9, 2018
package.json v2.0.0-rc.6 Dec 18, 2018

README.md

create-openapi-repo

NPM version Dependency Status

Generator for OpenAPI repository

Why?

There are a few advantages in hosting your API specification + docs on GitHub:

  • Community engagement (PR's and issues)
  • Hosting on GitHub pages (perfect uptime, CDN, Jekyll, custom domains with CNAME)
  • Advertisment in the GitHub community
  • Revision history, branching, CI
  • Fast on-boarding time (everyone knows how to use GitHub πŸ˜„)

Features

This generator helps to create a GitHub repo with the following features:

  • Possibility to split a big OpenAPI spec into smaller files and bundle it for deployment
  • Continuous integration/deployment on Travis
  • Code samples as separate files
  • OpenAPI spec is validated after each commit
  • OpenAPI spec + ReDoc deployed to Github Pages (you can use a custom domain)
  • Live editing in your editor or swagger-editor 😍 live editing

Examples of generated repositories

How to generate your repository

We assume you already have node.js installed.

  • Install create-openapi-repo globally:
npm install -g create-openapi-repo

or use npx:

npx create-openapi-repo <spec-root>
create-openapi-repo .
  • Commit and push your changes to the GitHub and follow instruction from README.md of your newly created repo.
You can’t perform that action at this time.