Comments (2)
fbenz
commented on August 27, 2024
Spring Auto REST Docs does not have that feature and we have not thought about it yet. But it's an interesting idea. It shouldn't be enabled by default, but would be a nice feature hidden behind a flag. We are reading Javadoc on the method, the method parameters and the request and the response body. For an initial implementation it should be fine to fail if any of the comments are missing because it most cases you want all.
from spring-auto-restdocs.
dacofr
commented on August 27, 2024
Hi,
It's ok for me to fail if comments are missing.
Maybe it could an option in the doclet that parse the javadoc ?
OK to have a feature flag who is desactivated by default.
Any idea when this feature could be implémenter ?
from spring-auto-restdocs.
Related Issues (20)
- ArrayLimitingJsonContentModifier does not limit array
- Documenting RequestParam DTOs HOT 20
- Wrong type for Instant[] HOT 1
- Append description for Instant types
- Support Java 14 Records HOT 7
- Documentation extracting Doclet does not recognize overloaded methods.
- Does it make sense to extract the Javadoc extracting Doclet into a separate project? HOT 2
- Supports for Spring Webflux Functional Endpoint HOT 1
- Missing releases after 2.0.5 on maven central HOT 1
- ModelAttribute does not resolve fields without @JsonProperty HOT 3
- Gradle 7/Kotlin 1.5 support HOT 6
- Comment with only tag are wrong with spring-auto-restdocs-json-doclet-jdk9
- RequestParam with complex data structure is not flattened HOT 2
- 0
- Request Field comments are not coming the generated request field adoc files. HOT 1
- Latest JDK Support (Java 17 and above ) for the issue [WARNING] javadoc: warning - The old Doclet and Taglet APIs in the packages
- Please support jpms HOT 2
- NoClassDefFoundError when running with 3.5.0 maven-doc-plugin
- Spring Boot 3.x and Jakarta Validation API - RequestBody fields annotated with @NotNull are Optional true in generated documentation HOT 2
- Do you have plans to support the OpenAPI Specification project.? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from spring-auto-restdocs.