Direct Freight Load Board OpenAPI Specification

Links

• Documentation (ReDoc): http://apidocs.directfreight.com/
• Try It Out (SwaggerUI): http://apidocs.directfreight.com/swagger-ui/
• Look at full spec:
  • JSON http://apidocs.directfreight.com/swagger.json
  • YAML http://apidocs.directfreight.com/swagger.yaml

Editing specification with swagger-editor

1. Run npm start (Install Node JS and run npm install inside of the repo first if you haven't yet)
2. 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>
3. Make changes using your favorite editor or swagger-editor (look for URL in console output)
4. 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
5. Once you finish with the changes you can run tests using: npm test and then push them to github.

Misc

• 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.