Minimalistic API linter of awesomeness, bringing order to a sea of APIs.
- Ensures API definitions conform to our standard REST guidelines.
- Does not require a deployed service, only an API definition.
- Accepts swagger yaml and json formats.
- Easy-to-use CLI allows you to check your API right now.
- Parses swagger files using swagger-parser
- Written in Java 8 with Spring Boot
- Zally comes with a server which lints your swagger files
- Zally CLI is handy command-line tool, it uses the server in the background
- Rule changes only have to be applied in the server component
Tech Stack: Zally server is written in Java 8 with Spring Boot. We made rule implementation optional possible in Kotlin. API-specific code remains in Java 8 due to better integration with Spring Boot. Further details can be found here. With Spring 5 we consider using Kotlin also on API side directly. Stay tuned.
- Java 8
You can find installation steps in the Server Readme and CLI Readme.
If you just wanna try it out: first run the server locally, then just use the cli tool as it is provided.
For version 1.0 we focus on these three main areas:
- improve rule implementations
- improve CLI user experience
- improve web UI
Feel free to contribute on related issues for version 1.0.
Afterwards we focus on Github integration and more sophisticated features.
We are happy to accept contributions. First, take a look at our contributing guidelines.
You can see our current status in this task board.
Please check the Issues Page for contribution ideas.
Feel free to contact one the maintainers
MIT license with an exception. See license file.