A minimalistic, simple-to-use API linter
Zally is a quality assurance tool. It's a linter for OpenAPI specifications, which:
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.
Trying out Zally is easy. You can build and run the whole Zally stack (web-ui, server and database) by executing:
Web UI is accessible on
http://localhost:8080; Zally server on
Please consult the following documents for more information:
For Zally version 1.5, we're focusing on:
If you have ideas for these items, please let us know.
Zally is not the only linter for OpenAPI v2 and v3. There is an article comparing different OpenAPI linters.
So why should you choose Zally? - It supports Zalando's RESTful Guidelines - It can be used in multiple ways: RESTful API, CLI and Web interface - Highly customizable (with Kotlin)
MIT license with an exception. See license file.
OSSRH_JIRA_PASSWORDenvironment variables to access Maven Central Repo are configured
-SNAPSHOTto a final version.
cd server ./gradlew clean build publishAllPublicationsToMavenRepository
server/gradle.propertieswith the release version
shell script git tag v -m "Version "6. Bump version in
server/gradle.propertiesto the next
releasebranch and tag
shell script git push origin git push origin8. Create a Pull Request with the version update 9. Create and publish a release with a new version in GitHub