springdoc-openapi
PMD
springdoc-openapi | PMD | |
---|---|---|
18 | 22 | |
3,120 | 4,698 | |
0.8% | 0.7% | |
9.0 | 9.9 | |
9 days ago | 2 days ago | |
Java | Java | |
Apache License 2.0 | GNU General Public License v3.0 or later |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
springdoc-openapi
-
Creation and Usage of BOM in Gradle
The issue is that the springdoc-openapi BOM brings an old version of the Spring Framework 6.0, which is incompatible with Spring Boot 3.2. There are several ways to solve this problem: update springdoc, change the order of BOM imports, but the best, in my opinion, is to avoid using the io.spring.dependency-management plugin.
-
Setting up swagger
I would suggest using Springdoc
- How to deal with toxicity within the community, in context of big open source projects?
-
Spring Boot – Black Box Testing
The SpringDoc library comes with lots of annotations to tune your REST API specification precisely. Anyway, that's out of context of this article.
-
What do you think about generating OpenAPI specs from code?
I found SpringDoc, a library that automates the generation of the spec from the source code. It relies on annotations for textual bits (like tags and descriptions), but it also infers stuff from Spring annotations.
-
Removies
This is an API made with Spring Web, uses springdoc-openapi-ui to expose a swagger-ui on http://localhost:8080/swagger-ui/index.html
-
Pulling out OpenAPI 3.0 Specifications from SpringBoot
Libraries like Springdoc or Springfox can do this. These libraries generate the OpenAPI documentation based on your controllers (+ you can apply the OpenAPI annotations on your controllers). This documentation is then exposed as a REST API, for Springdoc these can be found at /v3/api-docs.
-
Eureka Service Registration and Discovery
Retrieving all endpoints of a service isn't the goal of a service registry like Eureka, so no, you can't get all endpoints of a service. You can use a library like Springfox or Springdoc to enable Swagger/OpenAPI for your project. These libraries generate a JSON REST API (and a user interface) to view all your endpoints. You can even provide additional information (eg. default values, descriptions, ...) by adding some additional annotations on your controllers.
-
OpenAPI Specification: The Complete Guide
The springdoc-openapi helps automating the generation of API documentation using Spring Boot projects GitHub - springdoc/springdoc-openapi
-
Java Spring EventSourcing and CQRS Clean Architecture microservice 👋⚡️💫
Our microservice accept http requests: For swagger used Swagger OpenAPI 3. The bank account REST controller, which accept requests, validate it using Hibernate Validator, then call command or query service. The main reason for CQRS gaining popularity is the ability to handle reads and writes separately due to severe differences in optimization techniques for those much more distinct operations.
PMD
-
We Have Code Quality At Home: Open Source Java Code Quality Tools
PMD is a source code static analysis tool. It inspects your Java files for any issues, and has a configurable set of rules to look at.
- PMD 7 Is Here
-
Amazon CodeGuru Reviewer: already time for retirement?
While the security findings can be pretty elaborate and helpful, the code quality and performance focused findings are not that impressive and can often be detected by more basic or powerful tools like SonarQube (paying) or PMD (free). To see what I mean you can have a look at the list of Java code quality detectors, which is pretty short and contains a lot of simple findings like:
-
Code Review for Flows
Also saw this convo has a couple years worth of ideas going on … https://github.com/pmd/pmd/issues/3413
-
Custom Gradle Plugin for Unified Static Code Analysis
PMD and Checkstyle are static analysis tools that check your code on each project build. Gradle allows to apply them easily.
-
Spring Boot – Black Box Testing
The generated classes should be put into .gitignore. Otherwise, if you have Checkstyle, PMD, or SonarQube in your project, then generated classes can violate some rules. Besides, if you don't put them into .gitignore, then each pull request might become huge due to the fact that even a slightest fix can lead to lots of changes in the generated classes.
-
After Java tutorials, now what???
- PMD Static Code Analysis tool: https://pmd.github.io/
-
Ask HN: What is a modern Java environment?
PMD, Spotbugs, Nullaway: Java linting/static analysis (https://pmd.github.io, https://spotbugs.github.io, https://github.com/uber/NullAway)
-
Code smell plugin
PMD, and checkstyle as well.
-
Writing Clean and Consistent Code with Static Analysis using PMD and Apex
Open up the config/ruleset.xml file, and you’ll find an XML document that lists several rules. These rules map to the issues which PMD will report on. Believe it or not, there are hundreds of Apex rules, and you can find the full set at the PMD repo. You have complete control over which rules to enable. Typically, you’d determine which ones are important by agreeing with your teammates on the ones that matter most. After all, their code will be statically analyzed, too!
What are some alternatives?
springfox - Automated JSON API documentation for API's built with Spring
Spotbugs - SpotBugs is FindBugs' successor. A tool for static analysis to look for bugs in Java code.
swagger-core - Examples and server integrations for generating the Swagger API Specification, which enables easy access to your REST API
SonarQube - Continuous Inspection
javalin - A simple and modern Java and Kotlin web framework [Moved to: https://github.com/javalin/javalin]
Error Prone - Catch common Java mistakes as compile-time errors
hibernate-validator - Hibernate Validator - Jakarta Bean Validation Reference Implementation
Checkstyle - Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. By default it supports the Google Java Style Guide and Sun Code Conventions, but is highly configurable. It can be invoked with an ANT task and a command line program.
Elide - Elide is a Java library that lets you stand up a GraphQL/JSON-API web service with minimal effort.
infer - A static analyzer for Java, C, C++, and Objective-C
openapi-generator - OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
SonarJava - :coffee: SonarSource Static Analyzer for Java Code Quality and Security