Its standard configuration will check your APIs against the rules defined in Zalando's RESTful Guidelines, but anyone can use it out-of-the-box.
Zally's easy-to-use CLI uses the server in the background so that you can check your API on the spot. It also features an intuitive Web UI that shows implemented rules and lints external files and (with its online editor) API definitions.
- Support for OpenAPI 3 and (Swagger) OpenAPI 2 specifications
- RESTful API, CLI and Web interface
- Rich Check configuration
- Ignore functionality (
x-zally-ignoreextension) - Java/Kotlin API for new Checks + helper functions
- Permanils to linting results and statistics
Trying out Zally is easy. You can build and run the whole Zally stack (web-ui, server and database) by executing:
./build-and-run.shWeb UI is accessible on http://localhost:8080; Zally server on http://localhost:8000
Please consult the following documents for more information:
Zally welcomes contributions from the open source community. To get started, take a look at our contributing guidelines. Then check our Project Board and Issues Tracker for ideas.
For Zally version 1.5, we're focusing on:
- Making Zally easier to extend and adjust to custom guidelines and rules
- Better integration testing approaches
- Making further rules compatible with OpenAPI 3
- Providing more utilities for check developers
- Improving check execution process
- Provide high-quality documentation for check developers, operators and users
If you have ideas for these items, please let us know.
Feel free to join our Gitter room or contact one of the maintainers directly.
MIT license with an exception. See license file.