Skip to content

Add primary annotations to the documentation #3142

@IgnatBeresnev

Description

@IgnatBeresnev

Is your feature request related to a problem? Please describe.

I'm adding springdoc v2 to a new project and I'm having a hard time remembering which annotations to use to document my DTOs and endpoints.

Naturally, I go to the official documentation (springdoc.org), but does not have a section about primary annotations/properties, or in other words there is no "Get started" that goes beyond just adding the dependency.

So I either have to look at the source code of your examples at the very bottom or open one of my other projects that has springdoc v2 and copy the annotations/properties from there.

Describe the solution you'd like

A section in the docs that gives a few basic examples:

  • Documenting a controller
  • Documenting an endpoint
  • Documenting a DTO

It should probably be under the "Getting started" section, right below the dependency block.

Additional context

I've used springdoc v1 and springfox before and a lot, so I know their annotations, but things changed in v2 and I'm still trying to remember it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions