- Documentation (ReDoc): http://apidocs.directfreight.com/
- Try It Out (SwaggerUI): http://apidocs.directfreight.com/swagger-ui/
- Look at full spec:
- Run
npm start(Install Node JS and runnpm installinside of the repo first if you haven't yet) - Checkout console output to see where local server is started. You can use all links (except
preview) by replacing https://direct-freight.github.io/df-api-docs/ 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 andswagger-uiin parallel - Once you finish with the changes you can run tests using:
npm testand then push them to github.
- Preview spec version for branch
[branch]: https://apidocs.directfreight.com/preview/[branch] - [Optional] If you document public API consider adding it into APIs.guru directory using this form.