Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zalando/zally
A minimalistic, simple-to-use API linter
https://github.com/zalando/zally
api api-linter api-management developer-infrastructure golang hacktoberfest kotlin linter openapi spring-boot swagger
Last synced: 4 days ago
JSON representation
A minimalistic, simple-to-use API linter
- Host: GitHub
- URL: https://github.com/zalando/zally
- Owner: zalando
- License: mit
- Created: 2016-12-19T10:38:18.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-11-28T09:39:13.000Z (about 2 months ago)
- Last Synced: 2025-01-02T06:05:48.024Z (11 days ago)
- Topics: api, api-linter, api-management, developer-infrastructure, golang, hacktoberfest, kotlin, linter, openapi, spring-boot, swagger
- Language: Kotlin
- Homepage: https://zalando.github.io/zally
- Size: 11 MB
- Stars: 914
- Watchers: 27
- Forks: 144
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY
Awesome Lists containing this project
- awesome-integration - Zally (⭐914) - Ensure the quality of your OpenAPI specs with this linter tool that provides extensive analysis and feedback. (Projects / API Design)
- trackawesomelist - Zally (⭐914) (⭐908) - Ensure the quality of your OpenAPI specs with this linter tool that provides extensive analysis and feedback. (Recently Updated / [Dec 11, 2024](/content/2024/12/11/README.md))
- jimsghstars - zalando/zally - A minimalistic, simple-to-use API linter (Kotlin)
README
# Zally: A minimalistic, simple-to-use OpenAPI 2 and 3 linter
[](https://travis-ci.org/zalando/zally)
[](https://www.codacy.com/app/zally/zally?utm_source=github.com&utm_medium=referral&utm_content=zalando/zally&utm_campaign=Badge_Grade)
[](https://gitter.im/zalando/zally?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Zally is a quality assurance tool. It's a linter for OpenAPI specifications,
it performs the following tasks :
- Increases the quality of APIs
- Checks compliance
- Delivers early feedback for API designers
- Ensures the same look-and-feel of APIs
- Supports [API-First approach](https://opensource.zalando.com/restful-api-guidelines/#100)
- Provides best practices and advices
Its standard configuration will check your APIs against the rules defined in
[Zalando's RESTful Guidelines](http://zalando.github.io/restful-api-guidelines/),
but anyone can use it **out-of-the-box**.
Zally has an easy-to-use [CLI](cli/README.md) which uses the server in the background so that
you can check your API *on the spot*. It also features an intuitive
[Web UI](web-ui/README.md) that shows implemented rules and lints external files
and (with its online editor) API definitions.
## Features
- Support for OpenAPI 3 and (Swagger) OpenAPI 2 specifications
- RESTful API, CLI and Web interface
- Rich Check configuration
- Ignore functionality (`x-zally-ignore` extension)
- Java/Kotlin API for new Checks + helper functions
## Quick start guide
Trying out Zally is easy. You can build and run the whole Zally stack (web-ui, server
and database) by executing:
```bash
docker compose up -d
```
Web UI is accessible on `http://localhost:8080`; Zally server on `http://localhost:8000`
## Documentation and Manuals
Please consult the following documents for further information:
- [Zally Concepts](documentation/concepts.md)
- [How to operate](documentation/operation.md) Zally tools
- [How to use Zally](documentation/usage.md)
- [How to develop new Rules](documentation/rule-development.md)
- [Building Under Windows Subsystem for Linux](documentation/build-under-wsl.md)
## Integrations
- [Zally Maven Plugin](https://github.com/ethlo/zally-maven-plugin) (unofficial)
## Contributing to Zally
Zally welcomes contributions from the open source community. To get started, take a
look at our [contributing guidelines](CONTRIBUTING). Then check our
[Project Board](https://github.com/zalando/zally/projects/1) and
[Issues Tracker](https://github.com/zalando/zally/issues) for ideas.
## Contact
Feel free to join our [Gitter room](https://gitter.im/zalando/zally) or contact one
of the [maintainers](MAINTAINERS) directly.
## Alternatives
Zally is not the only linter for OpenAPI v2 and v3. There is [an article](https://nordicapis.com/8-openapi-linters/) comparing different OpenAPI linters.
So why should you choose Zally?
- It supports [Zalando's RESTful Guidelines](http://zalando.github.io/restful-api-guidelines/)
- It can be used in multiple ways: RESTful API, CLI and Web interface
- Highly customizable (with Kotlin)
## License
MIT license with an exception. See [license file](LICENSE).
## Publish
### Prerequisites
* [Signing plugin](https://docs.gradle.org/current/userguide/signing_plugin.htm) configured
* `OSSRH_JIRA_USERNAME` and `OSSRH_JIRA_PASSWORD` environment variables to access [Maven Central Repo](https://oss.sonatype.org/) are
configured
### Steps
1. Create a separate branch with a name `release-`.
2. Update current version in `server/gradle.properties` from `-SNAPSHOT` to a final version.
3. Update mime types configuration:
```shell
./gradlew -q generate-media-types-config --info
```
4. Commit the updated file to the repository.
5. Release Zally server and API using the command
```
cd server
./gradlew clean build publishAllPublicationsToMavenRepository
```
6. Commit `server/gradle.properties` with the release version
7. Create a tag
```shell script
git tag v -m "Version "
```
8. Bump version in `server/gradle.properties` to the next `-SNAPSHOT`
9. Push `release` branch and tag
```shell script
git push origin
git push origin
```
10. Create a Pull Request with the version update
11. Create and publish a release with a new version in GitHub