Home
TL;DR: Dragonfruit is a tool which creates APIs from real data. It allows designers, developers, and data modelers to collaborate better and to quickly iterate APIs, applications, and data models.
Go to the Dragonfruit Starter repository and follow the instructions there.
Dragonfruit introspects your sample data, translates it into an API specification, and then serves APIs based on that specification. This allows you to quickly build, test and tweak APIs and data models.
Dragonfruit uses the Swagger API specification format, and so plays nicely with the larger Swagger tooling ecosystem.
To install Dragonfruit on Macs use Homebrew: brew install dragonfruit. For other systems or check out the instructions to build from source.
For more information on running Dragonfruit, check out the documentation at Dragonfruit CLI.
- How Dragonfruit builds API endpoints
- How Dragonfruit parses your data into models and queries
- Best practices and opinions
- Other tips and common questions
We welcome contributions. Your code is awesome.
Please read [Dragonfruit's application architecture] to get a sense of the different components within the codebase.
Some things we'd love to have:
- Support for more database back-ends
- Support and validation for more string formats
- More examples and quick starts
- Better installation and distribution on non-Macintosh systems
- Support for more types of sample data (like CSV)
Please send contributions as a pull request, make sure your changes compile and are formatted with Gofmt, and ensure that all changes pass tests defined in Dragonfruit Testing.
The Dragonfruit project contains several repositories:
- Dragonfruit Core - the internal libraries for Dragonfruit (mainly for people who want to develop new functionality)
- Dragonfruit CLI - the command line interface for Dragonfruit
- Dragonfruit Starter - a quickstart example project
- Dragonfruit Testing - integration tests for Dragonfruit