Live API Docs

DreamFactory Live API Docs is an automatically generated interactive API documentation for every service configured in a DreamFactory instance. DreamFactory uses Swagger 2.0 Specification, the most popular open source project for API documentation (aka OpenAPI Specification as of 2016). Live documentation allows you to not only see the request and response types and requirements for the various services configured on an instance, but also test all of them before building an application.

Many of DreamFactory's services come with pre-defined Swagger definitions, like system and SQL databases service types. Others, like HTTP Services and Script Services must be customized to detail what each service provides. This can easily be done by using the built in text editor in the admin application, writing in JSON or YAML, or importing files of either format. You can also validate a definition by using the public Swagger Editor.