search

avishaan / lightTribe

LightTribe Backend and Collaboration Doc
2 stars 0 forks source link

Create swagger-ui documentation at gh-pages #14

Open avishaan opened 9 years ago

avishaan commented 9 years ago

Create test swagger-ui documentation to make sure it will work ok with gh-pages

avishaan commented 9 years ago

Github pages may not be appropriate for this use case. Pros and Cons of gh-pages as follows. Pros: Doesn't spin up server Independent from server Nice easy to find consistent url Cons: Always public and easy to find Cross Origin Request Issues prevent the response information from coming through Requires scripts in order to copy the swagger.json to a separate branch Requires an additional publishing step Requires an additional gh-pages branch to maintain and keep up to date.