Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apiaddicts/sonaropenapi-rules
sonaropenapi-rules is a set of rules to validate OpenAPI / Swagger api definitions in SonarQube, you also need to install the evaluation engine.
https://github.com/apiaddicts/sonaropenapi-rules
openapi openapi3 openapi31 sonarqube swagger
Last synced: 3 months ago
JSON representation
sonaropenapi-rules is a set of rules to validate OpenAPI / Swagger api definitions in SonarQube, you also need to install the evaluation engine.
- Host: GitHub
- URL: https://github.com/apiaddicts/sonaropenapi-rules
- Owner: apiaddicts
- License: lgpl-3.0
- Created: 2020-12-02T15:15:59.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-05T15:08:32.000Z (5 months ago)
- Last Synced: 2024-11-14T13:44:53.385Z (3 months ago)
- Topics: openapi, openapi3, openapi31, sonarqube, swagger
- Language: HTML
- Homepage: https://www.apiaddicts.org/apitools/
- Size: 520 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🛠️ sonaropenapi-rules   [](https://www.gnu.org/licenses/lgpl-3.0)
This repository contains a set of custom SonarQube rules specifically designed to analyze and improve the quality of OpenAPI specifications. By integrating these rules, teams can ensure best practices, maintainability, and consistency in their API definitions.
### This repository is intended for :octocat: **community** use, it can be modified and adapted without commercial use. If you need a version, support or help for your **enterprise** or project, please contact us 📧 [email protected]
### 💡 If you have an idea for a rule but you are not sure that everyone needs it you can implement a [custom rule](CustomRules.md) available only for you.
[](https://twitter.com/APIAddicts)
[](https://discord.gg/ZdbGqMBYy8)
[](https://www.linkedin.com/company/apiaddicts/)
[](https://www.facebook.com/apiaddicts)
[](https://www.youtube.com/@APIAddictslmaoo)
# 🙌 Join the **doSonarApi** Adopters list
📢 If doSonarApi is part of your organization's toolkit, we kindly encourage you to include your company's name in our Adopters list. 🙏 This not only significantly boosts the project's visibility and reputation but also represents a small yet impactful way to give back to the project.
| Organization | Description of Use / Referenc |
|---|---|
| [CloudAppi](https://cloudappi.net/) | Apification and generation of microservices |
| [Madrid Digital](https://www.comunidad.madrid/servicios/sede-electronica/madrid-digital/) | Generation of microservices |
| [Apiquality](https://apiquality.io/) | Generation of microservices |
# 👩🏽💻 Contribute to ApiAddicts
We're an inclusive and open community, welcoming you to join our effort to enhance ApiAddicts, and we're excited to prioritize tasks based on community input, inviting you to review and collaborate through our GitHub issue tracker.
Feel free to drop by and greet us on our GitHub discussion or Discord chat. You can also show your support by giving us some GitHub stars ⭐️, or by following us on Twitter, LinkedIn, and subscribing to our YouTube channel! 🚀
[](https://www.buymeacoffee.com/apiaddicts)
# 📑 Getting started
## 🔍 Configure scanner
### Maven plugin
#### Configure properties
In `pom.xml` configure:
````xml
openapi
.
````
#### Run scanner
`mvn sonar:sonar -Dsonar.host.url= -Dsonar.login=`
### External `sonar-scanner`
#### Install `sonar-scanner`
Download the `sonar-scanner` from https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/ and make it accessible.
#### Configure properties
In `sonar-project.properties` (file in root project folder) configure:
````properties
# must be unique in a given SonarQube instance
sonar.projectKey=test:test
# this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.
sonar.projectName=OpenAPI plugin tests
sonar.projectVersion=1.0-SNAPSHOT
# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
# This property is optional if sonar.modules is set.
sonar.sources=.
# Encoding of the source code. Default is default system encoding
sonar.sourceEncoding=UTF-8
# Select the language to use for analysis
sonar.language=openapi
````
#### ▶️ Run scanner
`sonar-scanner -Dsonar.host.url= -Dsonar.login=`
## ✅ Compatibility
This plugin is supported by SonarQube versions greater or equal to `6.7.4`
### Explicit compatibility versions tested
| Version |
|---------|
| `6.7.4` |
| `7.9-community` |
| `8.3-community` |
## 💛 Sponsors
