Thingful OpenAPI Specification

Steps to finish

Enable Travis for your repository (note: you already have .travis.yml file)
Create GitHub access token; check public_repo on Select scopes section.
Use the token value as a value for Travis environment variable with the name GH_TOKEN
Make a test commit to trigger CI: git commit --allow-empty -m "Test Travis CI" && git push
Wait until Travis build is finished. You can check progress by clicking on the Build Status badge at the top
If you did everything correct, https://thingful.github.io/openapi-spec/ will lead to your new docs
[Optional] You can setup custom domain (just create web/CNAME file)
Start writing/editing your OpenAPI spec: check out usage section below
[Optional] If you document public API consider adding it into APIs.guru directory using this form.
Delete this section 😄

Warning: All above links are updated only after Travis CI finishes deployment

Run npm start
Checkout console output to see where local server is started. You can use all links (except preview) by replacing https://thingful.github.io/openapi-spec/ with url from the message: Server started <url>
Make changes using your favorite editor or swagger-editor (look for URL in console output)
All changes are immediately propagated to your local server, moreover all documentation pages will be automagically refreshed in a browser after each change TIP: you can open swagger-editor, documentation and swagger-ui in parallel
Once you finish with the changes you can run tests using: npm test
Share you changes with the rest of the world by pushing to GitHub 😄

Name		Name	Last commit message	Last commit date
Latest commit History 32 Commits
scripts		scripts
spec		spec
web		web
.gitignore		.gitignore
.travis.yml		.travis.yml
.yo-rc.json		.yo-rc.json
LICENSE		LICENSE
README.md		README.md
gulpfile.js		gulpfile.js
package.json		package.json