Skip to content

[BOUNTY #27215] Improve API First Development documentation#1572

Open
zhaog100 wants to merge 1 commit intojhipster:mainfrom
zhaog100:docs/improve-api-first-guide
Open

[BOUNTY #27215] Improve API First Development documentation#1572
zhaog100 wants to merge 1 commit intojhipster:mainfrom
zhaog100:docs/improve-api-first-guide

Conversation

@zhaog100
Copy link
Copy Markdown

Improvements

Adds 4 major new sections to the API First Development guide:

1. Working with DTOs, Entities, and MapStruct

  • MapStruct mapper creation pattern for API DTO ↔ Entity conversion
  • Injecting mappers into delegate implementations
  • Configuring model package alignment with JHipster structure

2. Managing JHipster Default Behaviors (Cruft)

  • How to disable auto-generated REST controllers
  • Guidance on avoiding JDL/OpenAPI Generator conflicts
  • When NOT to generate entities during project creation

3. JDL Kickstart for API First Workflow

  • Using JDL apiFirst true option
  • Generating base domain model before API spec
  • Post-generation cleanup steps

4. Complete End-to-End Example

  • Pet Store with database persistence using Spring Data JPA
  • MapStruct DTO mapping
  • Delegate implementation pattern
  • Cleanup of conflicting JDL-generated controllers

Closes #27215

Add comprehensive sections covering:

1. DTOs, Entities, and MapStruct integration
   - MapStruct mapper creation pattern
   - Injecting mappers into delegate implementations
   - Aligning generated model packages with JHipster structure

2. Managing JHipster default behaviors (cruft)
   - Disabling auto-generated REST controllers
   - Avoiding conflicts between JDL and OpenAPI Generator

3. JDL kickstart for API First workflow
   - Using JDL to generate base domain model
   - apiFirst config option
   - Post-generation cleanup steps

4. Complete end-to-end example
   - Pet Store with database persistence
   - MapStruct DTO mapping
   - Delegate implementation with Spring Data JPA
   - Cleanup of conflicting controllers

Closes #27215
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 20, 2026

Deploy Preview for jhipster-site ready!

Name Link
🔨 Latest commit 8da449b
🔍 Latest deploy log https://app.netlify.com/projects/jhipster-site/deploys/69bc8e2c9fbbe700083194ea
😎 Deploy Preview https://deploy-preview-1572--jhipster-site.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant