Skip to main content
spring-boot-openapi-documentation Provides patterns to generate comprehensive REST API documentation using SpringDoc OpenAPI 3.0 and Swagger UI in Spring Boot 3.x applications. Use when setting up API documentation, configuring Swagger UI, adding OpenAPI annotations, implementing security documentation, or enhancing REST endpoints with examples and schemas.
الانتقال إلى التثبيت سوق المهارات اكتشف واستكشف مهارات الذكاء الاصطناعي التي بناها المجتمع.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
عرض تفاصيل Prompt يتجاوز الأمر المباشر Prompt المخصّص للمراجعة. افحص المصدر قبل تشغيله.
npx skills add https://github.com/giuseppe-trisciuoglio/developer-kit --skill spring-boot-openapi-documentationيبقى الأمر في سطر واحد. مرّر أفقيًا لمراجعته كاملًا قبل النسخ.
تفضّل نسخة محلية؟ نزّل الملفات المتاحة حاليًا لدى SkillsMP.
تحميل Zip جاري التحميل... المهن ذات الصلة SOC
استنادا إلى تصنيف SOC المهني
typescript-security-review Provides security review capability for TypeScript/Node.js applications, validates code against XSS, injection, CSRF, JWT/OAuth2 flaws, dependency CVEs, and secrets exposure. Use when performing security audits, before deployment, reviewing authentication/authorization implementations, or ensuring OWASP compliance for Express, NestJS, and Next.js. Triggers on "security review", "check for security issues", "TypeScript security audit".
name spring-boot-openapi-documentation description Provides patterns to generate comprehensive REST API documentation using SpringDoc OpenAPI 3.0 and Swagger UI in Spring Boot 3.x applications. Use when setting up API documentation, configuring Swagger UI, adding OpenAPI annotations, implementing security documentation, or enhancing REST endpoints with examples and schemas. allowed-tools Read, Write, Edit, Bash, Glob, Grep
Spring Boot OpenAPI Documentation with SpringDoc
Overview
SpringDoc OpenAPI automates generation of OpenAPI 3.0 documentation for Spring Boot projects with a Swagger UI web interface for exploring and testing APIs.
When to Use
Set up SpringDoc OpenAPI in Spring Boot 3.x projects
Generate OpenAPI 3.0 specifications for REST APIs
Configure and customize Swagger UI
Add detailed API documentation with annotations
Document request/response models with validation
Implement API security documentation (JWT, OAuth2, Basic Auth)
Document pageable and sortable endpoints
Add examples and schemas to API endpoints
Customize OpenAPI definitions programmatically
Support multiple API groups and versions
Document error responses and exception handlers
Add JSR-303 Bean Validation to API documentation
Support Kotlin-based Spring Boot APIs
Quick Reference
Concept Description Dependencies springdoc-openapi-starter-webmvc-ui for WebMvc,
springdoc-openapi-starter-webflux-ui
Configuration application.yml with springdoc.api-docs.* and springdoc.swagger-ui.* properties
Access Points OpenAPI JSON: /v3/api-docs, Swagger UI: /swagger-ui/index.html
Core Annotations @Tag, @Operation, @ApiResponse, @Parameter, @Schema, @SecurityRequirement
Security Configure security schemes in OpenAPI bean, apply with @SecurityRequirement
Pagination Use @ParameterObject with Spring Data Pageable
Instructions
1. Add Dependencies Add SpringDoc starter for your application type (WebMvc or WebFlux). See dependency-setup.md for Maven/Gradle configuration.
2. Configure SpringDoc Set basic configuration in application.yml:
springdoc:
api-docs:
path: /api-docs
swagger-ui:
path: /swagger-ui.html
operationsSorter: method
3. Document Controllers Use OpenAPI annotations to add descriptive information:
@RestController
@Tag(name = "Book", description = "Book management APIs")
public class BookController {
@Operation(summary = "Get book by ID")
@ApiResponse(responseCode = "200", description = "Book found")
@GetMapping("/{id}")
public Book findById (@PathVariable Long id) { }
}
4. Document Models Apply @Schema annotations to DTOs:
@Schema(description = "Book entity")
public class Book {
@Schema(example = "1", accessMode = Schema.AccessMode.READ_ONLY)
private Long id;
@Schema(example = "Clean Code", required = true)
private String title;
}
5. Configure Security Set up security schemes in OpenAPI bean:
@Bean
public OpenAPI customOpenAPI () {
return new OpenAPI ()
.components(new Components ()
.addSecuritySchemes("bearer-jwt" , new SecurityScheme ()
.type(SecurityScheme.Type.HTTP)
.scheme("bearer" )
.bearerFormat("JWT" )
)
);
}
6. Document Pagination Use @ParameterObject for Spring Data Pageable:
@GetMapping("/paginated")
public Page<Book> findAll (@ParameterObject Pageable pageable) {
return repository.findAll(pageable);
}
7. Test Documentation Access Swagger UI at /swagger-ui/index.html to verify documentation completeness.
8. Customize for Production
Best Practices
Use descriptive operation summaries : Short (< 120 chars), clear statementsDocument all response codes : Include success (2xx), client errors (4xx), server errors (5xx)Add examples to request/response bodies : Use @ExampleObject for realistic examplesLeverage JSR-303 validation annotations : SpringDoc auto-generates constraints from validation annotationsUse @ParameterObject for complex parameters : Especially for Pageable, custom filter objectsGroup related endpoints with @Tag : Organize API by domain entities or featuresDocument security requirements : Apply @SecurityRequirement where authentication neededHide internal endpoints appropriately : Use @Hidden or create separate API groupsCustomize Swagger UI for better UX : Enable filtering, sorting, try-it-out featuresVersion your API documentation : Include version in OpenAPI Info
References
dependency-setup.md configuration.md controller-documentation.md model-documentation.md security-configuration.md pagination-support.md advanced-configuration.md exception-handling.md build-integration.md complete-examples.md annotations-reference.md springdoc-official.md troubleshooting.md
Constraints and Warnings
Do not expose sensitive data in API examples or schema descriptions
Keep OpenAPI annotations minimal to avoid cluttering controller code; use global configurations when possible
Large API definitions can impact Swagger UI performance; consider grouping APIs by domain
Schema generation may not work correctly with complex generic types; use explicit @Schema annotations
Avoid circular references in DTOs as they cause infinite recursion in schema generation
Security schemes must be properly configured before using @SecurityRequirement annotations
Hidden endpoints (@Operation(hidden = true)) are still visible in code and may leak through other documentation tools
Examples
Basic Controller Documentation @RestController
@Tag(name = "Books", description = "Book management APIs")
@RequestMapping("/api/books")
public class BookController {
@Operation(
summary = "Get book by ID",
description = "Retrieves detailed information about a specific book"
)
@ApiResponse(responseCode = "200", description = "Book found")
@ApiResponse(responseCode = "404", description = "Book not found")
@GetMapping("/{id}")
public Book getBook (@PathVariable Long id) {
return bookService.findById(id);
}
@Operation(summary = "Create new book")
@SecurityRequirement(name = "bearer-jwt")
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public Book createBook (@Valid @RequestBody CreateBookRequest request) {
return bookService.create(request);
}
}
Documented Model with Validation @Schema(description = "Book entity")
public class Book {
@Schema(description = "Unique identifier", example = "1", accessMode = Schema.AccessMode.READ_ONLY)
private Long id;
@Schema(description = "Book title", example = "Clean Code", required = true)
@NotBlank
@Size(min = 1, max = 200)
private String title;
@Schema(description = "Author name", example = "Robert C. Martin")
@NotBlank
private String author;
@Schema(description = "Price in USD", example = "29.99", minimum = "0")
@NotNull
@DecimalMin("0.0")
private BigDecimal price;
}
Security Configuration @Bean
public OpenAPI customOpenAPI () {
return new OpenAPI ()
.info(new Info ()
.title("Book API" )
.version("1.0.0" )
.description("REST API for book management" ))
.components(new Components ()
.addSecuritySchemes("bearer-jwt" , new SecurityScheme ()
.type(SecurityScheme.Type.HTTP)
.scheme("bearer" )
.bearerFormat("JWT" ))
.addSecuritySchemes("api-key" , new SecurityScheme ()
.type(SecurityScheme.Type.APIKEY)
.in(SecurityScheme.In.HEADER)
.name("X-API-Key" )));
}
Related Skills
spring-boot-rest-api-standards — REST API design standardsspring-boot-dependency-injection — Dependency injection patternsunit-test-controller-layer — Testing REST controllersspring-boot-actuator — Production monitoring and management
External Resources 