Skip to content

wileymab/swagger-pages

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 

Repository files navigation

Swagger-Pages setup


Based on the work from Peter Evans

Read his work here: https://github.com/peter-evans/swagger-github-pages


  1. Make <your_api_project_dir> directory, and cd into it.
mkdir -p <your_api_project_dir>
cd <your_api_project_dir>
  1. Run the setup.sh script in <your_api_project_dir>.
bash -c "$(curl -fsSL https://raw.githubusercontent.com/wileymab/swagger-pages/master/setup.sh)"
  1. Initialize <your_api_project_dir> as a git working tree. (git init)
  2. Create the repo in github.com, and follow the setup for adding your github repo as your working tree remote.
  3. Go to Settings for you github repo, and enable Pages for the master branch.
  4. Once the pages link has been generated, you should be able to navigate to your new standalone swagger api docs.

Example @ https://github.com/wileymab/swagger-pages-test

Generated Swagger Pages link: https://wileymab.github.io/swagger-pages-test/

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages