Skip to content

carlosrobles/create-openapi-repo

 
 

Repository files navigation

create-openapi-repo

NPM version Dependency Status

Generator for OpenAPI repository

Why?

There are a few advantages in hosting your API definition + 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 (developers and tech writers know how to use GitHub 😄)
  • Fully compatible with Redocly API Reference too

Features

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

  • Possibility to split a big OpenAPI definition into smaller files and bundle it for deployment
  • Continuous integration/deployment on Travis
  • Code samples as separate files
  • OpenAPI definition is validated after each commit
  • OpenAPI definition + 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.

About

🤖 Generator for GH repo to help you manage the OpenAPI definition lifecycle

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 87.8%
  • HTML 7.8%
  • C# 2.6%
  • PHP 1.8%