CtrlK
BlogDocsLog inGet started
Tessl Logo

giuseppe-trisciuoglio/developer-kit

Comprehensive developer toolkit providing reusable skills for Java/Spring Boot, TypeScript/NestJS/React/Next.js, Python, PHP, AWS CloudFormation, AI/RAG, DevOps, and more.

89

Quality

89%

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

SecuritybySnyk

Risky

Do not use without reviewing

Overview
Quality
Evals
Security
Files

configuration.mdplugins/developer-kit-java/skills/spring-boot-openapi-documentation/references/

SpringDoc Configuration

Basic Configuration

application.properties

# API Documentation Path
springdoc.api-docs.path=/api-docs
springdoc.api-docs.enabled=true

# Swagger UI Configuration
springdoc.swagger-ui.path=/swagger-ui.html
springdoc.swagger-ui.enabled=true
springdoc.swagger-ui.operationsSorter=method
springdoc.swagger-ui.tagsSorter=alpha
springdoc.swagger-ui.tryItOutEnabled=true

# Package and Path Filtering
springdoc.packages-to-scan=com.example.controller
springdoc.paths-to-match=/api/**

application.yml

springdoc:
  api-docs:
    path: /api-docs
    enabled: true
  swagger-ui:
    path: /swagger-ui.html
    enabled: true
    operationsSorter: method
    tagsSorter: alpha
    tryItOutEnabled: true
  packages-to-scan: com.example.controller
  paths-to-match: /api/**

Access Endpoints

After configuration:

  • OpenAPI JSON: http://localhost:8080/v3/api-docs
  • OpenAPI YAML: http://localhost:8080/v3/api-docs.yaml
  • Swagger UI: http://localhost:8080/swagger-ui/index.html

Advanced Configuration Options

Disable Specific Features

# Disable Swagger UI
springdoc.swagger-ui.enabled=false

# Disable API docs
springdoc.api-docs.enabled=false

# Disable try-it-out
springdoc.swagger-ui.tryItOutEnabled=false

Sort Options

  • operationsSorter: method (HTTP method), alpha (alphabetical)
  • tagsSorter: alpha (alphabetical)
  • defaultModelsExpandDepth: Controls model expansion in UI

Filter by Package/Path

# Scan multiple packages
springdoc.packages-to-scan=com.example.controller,vendor.another.controller

# Match multiple paths
springdoc.paths-to-match=/api/**,/public/**

# Exclude paths
springdoc.paths-to-exclude=/actuator/**,/admin/**

plugins

developer-kit-java

skills

README.md

CHANGELOG.md

context7.json

CONTRIBUTING.md

README_CN.md

README_ES.md

README_IT.md

README.md

tessl.json

tile.json