A minimalistic, simple-to-use API linter
Clone or download
Latest commit 82e1b65 Oct 4, 2018
Permalink
Failed to load latest commit information.
.delivery fix: make docker tags generation more robust against duplications (#676) Mar 13, 2018
.github add api-management team as owners of the web-ui component Aug 10, 2018
cli fix(server): explicit signature for functional hostnames rule checks (#… Sep 27, 2018
examples example: Update travis integration example #615 Dec 28, 2017
github-integration gh-integration: Update Zally links in test fixtures #615 Dec 28, 2017
server feat(server): Added defense against NullPointerExceptions #832 Oct 2, 2018
web-ui fix: update lodash dependency (#797) Aug 16, 2018
.gitattributes Added .gitattributes to enforce consistent line endings #725 Jun 14, 2018
.gitignore Authenticate paths with optional trailing slash (#770) Jul 30, 2018
.travis.yml fix test port configuration (#773) Aug 13, 2018
.zally.yaml GH-478 update .zally.yaml Aug 25, 2017
.zappr.yaml ensure zalando it compliance #444 Jul 25, 2017
CONTRIBUTING CONTRIBUTING: fix a typo #625 Jan 9, 2018
LICENSE #318 Switched to publicly available PlingStemmer, Removed LGPL clause… May 17, 2018
MAINTAINERS github: Update Code Owners #623 Dec 27, 2017
README.md feat: prepare readme for the next release (#854) Sep 26, 2018
SECURITY docs: add SECURITY file (#408). Jul 10, 2017
_config.yml Set theme jekyll-theme-minimal Apr 6, 2017
build-and-run.sh refactor(server): Refactor addressing review comments #712 Sep 3, 2018
delivery.yaml including github integration component (bark) (#516) Sep 21, 2017
docker-compose-bark.yaml separated GH integration config from zally docker compose config Sep 25, 2017
docker-compose.yaml content parsing structure change + test improvements (#773) Aug 10, 2018
logo.png added zally logo to readme Feb 7, 2017

README.md

Build Status Codacy Badge Codacy Badge

Zally: A minimalistic, simple-to-use API linter

... for OpenAPI 3 and Swagger 2 API specifications.

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.

More about Zally:

  • OpenAPI-friendly: accepts OpenAPI 3 and Swagger Specifications .yaml and JSON formats; includes a server that lints your OpenAPI files; and parses OpenAPI files using swagger-parser
  • Using x-zally-ignore extension in your API definition, you can disable rules for a specific API
  • Applying rule changes is only necessary in the server component
  • API-specific code written in Java 8 with Spring Boot for better integration
  • Rule implementation is optimal/possible in Kotlin

Technical Dependencies

  • Kotlin and Java 8 (server) with Spring Boot
  • Golang 1.7+: for CLI
  • Node.js 7.6+: for web UI

Installation and Usage

To give Zally a quick try, first run the server locally and then use the CLI tool.

The Server Readme, CLI Readme and Web UI Readme include more detailed installation steps for each component.

Quick start guide

You can build and run the whole Zally stack (web-ui, server and database) by executing this script:

./build-and-run.sh

Web UI is accessible on http://localhost:8080; Zally server on http://localhost:8000

To run zally with github integration:

export GITHUB_OAUTH_TOKEN=your_github_oauth_token
export GITHUB_SECRET=your_github_secret

./build-and-run.sh --bark

Github webhook endpoint is accessible on http://localhost:8081/github_webhook More details about how to registerWebhooks

Contributing

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.

Roadmap

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.

Contact

Feel free to contact one the maintainers.

License

MIT license with an exception. See license file.