Implement Source DocumentationProvider, spring-mvc decommission - #11531

Merged
wing328 merged 37 commits into
OpenAPITools:masterfrom
cachescrubber:feature/sourceDocumentationProvider
Feb 12, 2022
Merged

Implement Source DocumentationProvider, spring-mvc decommission#11531
wing328 merged 37 commits into
OpenAPITools:masterfrom
cachescrubber:feature/sourceDocumentationProvider

Conversation

@cachescrubber

@cachescrubbercachescrubber commented Feb 5, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

Finish the DocumentationProvider Story (#11258)

Changes

When source is selected as DocumentationProvider, the original openapi spec is copied to the project and
is exposed via /openapi.{json,yaml}. Swagger-ui, if enabled, is configured to show this spec.

  • SpringCodegen now implements SwaggerUIFeatures. Use the useSwaggerUI parameter with the spring-boot library to use it. Swagger UI is enabled by default.
  • Upgrade swagger-ui to 4.4.1 including a customised swagger-ui.html
  • The SpringBootApplication class is renamed to OpenApiGeneratorApplication.java.
  • Introduce SpringBootTest.mustache as OpenApiGeneratorApplicationTests.java.
  • Remove option openapiDocketConfig. Replaced by documentationProvider=springfox.

Deprecation Warnings

  • springfox (documentationProvider): Springfox is deprecated for removal in version 7.0.0 of openapi-generator. The project seems to be no longer maintained (last commit is of Oct 14, 2020). It works with Spring Boot 2.5.x but not with 2.6. Spring Boot 2.5 is supported until 2022-05-19. Users of openapi-generator should migrate to the springdoc documentation provider which is, as an added bonus, OpenAPI v3 compatible.

Removals

  • spring-mvc (Library): The Spring MVC library is going to be removed in version 6.0.0 of openapi-generator. Users should upgrade to the Spring Boot based library. Since the library is based on dependencies which are declared EOL (spring-framework 4.x) and we have no plans to move it forward, it has to be removed for security and maintenance reasons.

Users who need to support Swagger1 Annotations (Annotate Model and Api using the Swagger Annotations 1.x library) could do so independently of Springfox using annotationLibrary=swagger1.

  • Shown in the command line help
  • Added to the generated documentation (spring.md)
  • Added to the generated README.md
  • Logged at WARNING level on each invocation.

PR checklist

  • [x ] Read the contribution guidelines.
  • [ x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [ x] Run the following to build the project and update samples: 
    ./mvnw clean package ./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • [ x] File the PR against the correct branch: master (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@cachescrubber
- Upgrade swagger-ui to 4.4.1
9c1d423
- Bring homeController.mustache up-to-date
- Main class is now OpenApiGeneratorApplication
- Introduce SpringBootTest.mustache
- Remove option swaggerDocketConfig/openapiDocketConfig in favor of documentationProvider.
@cachescrubber
Generate Samples
97e847c
@cachescrubber
Restore generator-online classes
bbffdcd
Fix spring-mvc builds
@cachescrubber
Generate Samples
9c351da
@cachescrubber
Do not generate SpringFoxConfiguration.java when reactive ist set.
56a49a6
@cachescrubber
Fix generation of SpringFoxConfiguration
403852a
@cachescrubber
Generate Documentation
502587d
@cachescrubber
Reactive support: add dependency management for springdoc-openapi-web…
9e29c02
…flux-ui
@cachescrubber
Generate Samples
6b153a7
@cachescrubber
Change SpringBootApplication to OpenApiGeneratorApplication
6315747
@cachescrubber
Generate Samples
82b2f5d
@cachescrubber
Implement SwaggerUIFeatures in SpringCodegen
6ea78d1
@cachescrubber
Generate Samples
339cd54
@cachescrubber
Add useSwaggerUI: true to some test configs
730bdd1
@cachescrubber
Generate Samples
396ad6a
@cachescrubber
Update Documentation
9f63b42
@cachescrubber

cachescrubber commented Feb 6, 2022

Copy link
Copy Markdown
ContributorAuthor

re-open to trigger CI

@cachescrubber

cachescrubber commented Feb 6, 2022

Copy link
Copy Markdown
ContributorAuthor

There is a new spring-boot sample, spring-boot-source.yaml. It has should be registered as a new CI build.

@cachescrubber

cachescrubber commented Feb 6, 2022

Copy link
Copy Markdown
ContributorAuthor

@wing328 , @welshm FYI

welshm
welshm reviewed Feb 6, 2022
View reviewed changes

@welshmwelshm left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor comment - I think that interface only is not exclusive to swagger-ui

Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328 added this to the 6.0.0 milestone Feb 8, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
30ba4d5
# Conflicts:
#	modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/openapi2SpringBoot.mustache
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/java-camel/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/.openapi-generator/FILES
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
@cachescrubber
Generate Samples
901cf29
@cachescrubber
Remove spring-mvc library
117edce
@cachescrubber

cachescrubber commented Feb 10, 2022

Copy link
Copy Markdown
ContributorAuthor

@wing328 Could you remove the sprng-mvc samples from the CI configuration?

Lars Uffmann added 2 commits February 10, 2022 08:50
Lars Uffmann
Merge branch 'master' into feature/sourceDocumentationProvider
87367b6
# Conflicts:
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
Lars Uffmann
Remove spring-mvc from project and CI configs
33101fe
@cachescrubber

cachescrubber commented Feb 10, 2022

Copy link
Copy Markdown
ContributorAuthor

Could you remove the sprng-mvc samples from the CI configuration?

I think I have done it with 87367b6. Please review.

welshm
welshm approved these changes Feb 11, 2022
View reviewed changes

@welshmwelshm left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone requests the ability to generate the HTML with interfaces inky later, it's easy enough to reevaluate if that's a valid configuration we'd want to support.

Only other comment is about generating tests (I think there's a global generator property on whether or not tests should be output)

Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328 changed the title Implement Source DocumentationProviderImplement Source DocumentationProvider, spring-mvc decomissinoFeb 12, 2022
@wing328wing328 changed the title Implement Source DocumentationProvider, spring-mvc decomissinoImplement Source DocumentationProvider, spring-mvc decommissionFeb 12, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
a59adf1
# Conflicts:
#	samples/server/petstore/spring-mvc-default-value/src/main/java/org/openapitools/api/TestHeadersApi.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java
@cachescrubber
Generate samples
82eee37
@cachescrubber
Merge remote-tracking branch 'origin/feature/sourceDocumentationProvi…
7ca877b
…der' into feature/sourceDocumentationProvider
@cachescrubber
Generate samples
41c5027
@cachescrubber
Generate samples
ed761ac
@cachescrubber

cachescrubber commented Feb 12, 2022

Copy link
Copy Markdown
ContributorAuthor

Circle-CI failures are not caused by this pr IMO.

@wing328

wing328 commented Feb 12, 2022

Copy link
Copy Markdown
Member

CircleCI failures not related to this PR.

@wing328
wing328 merged commit 0ed147e into OpenAPITools:masterFeb 12, 2022
@cachescrubber
cachescrubber deleted the feature/sourceDocumentationProvider branch February 12, 2022 10:01
@cachescrubbercachescrubber mentioned this pull request Feb 12, 2022
Open
@sjoblomjsjoblomj mentioned this pull request Apr 20, 2022
Merged
4 tasks
@boardtc

boardtc commented Jan 20, 2023•
edited
Loading

Copy link
Copy Markdown

fyi, Moving from 5.0.0 to 6.3.0-SNAPSHOT.a s suggested I tried spring-boot, but it does not recognise that library unless generatorName is set to spring

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

Reviewers

@wing328wing328wing328 left review comments
@jimschubertjimschubertAwaiting requested review from jimschubert
+1 more reviewer
@welshmwelshmwelshm approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

DecommissionEnhancement: FeatureServer: JavaServer: Spring

Projects

None yet

Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

4 participants

@cachescrubber@wing328@boardtc@welshm
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Implement Source DocumentationProvider, spring-mvc decommission - #11531
Merged
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Feb 12, 2022
Merged
Implement Source DocumentationProvider, spring-mvc decommission#11531
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Feb 5, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Finish the DocumentationProvider Story (#11258)
Changes
When source is selected as DocumentationProvider, the original openapi spec is copied to the project and

is exposed via /openapi.{json,yaml}. Swagger-ui, if enabled, is configured to show this spec.
  • SpringCodegen now implements SwaggerUIFeatures. Use the useSwaggerUI parameter with the spring-boot library to use it. Swagger UI is enabled by default.
  • Upgrade swagger-ui to 4.4.1 including a customised swagger-ui.html
  • The SpringBootApplication class is renamed to OpenApiGeneratorApplication.java.
  • Introduce SpringBootTest.mustache as OpenApiGeneratorApplicationTests.java.
  • Remove option openapiDocketConfig. Replaced by documentationProvider=springfox.
Deprecation Warnings
  • springfox (documentationProvider): Springfox is deprecated for removal in version 7.0.0 of openapi-generator. The project seems to be no longer maintained (last commit is of Oct 14, 2020). It works with Spring Boot 2.5.x but not with 2.6. Spring Boot 2.5 is supported until 2022-05-19. Users of openapi-generator should migrate to the springdoc documentation provider which is, as an added bonus, OpenAPI v3 compatible.
Removals
  • spring-mvc (Library): The Spring MVC library is going to be removed in version 6.0.0 of openapi-generator. Users should upgrade to the Spring Boot based library. Since the library is based on dependencies which are declared EOL (spring-framework 4.x) and we have no plans to move it forward, it has to be removed for security and maintenance reasons.
Users who need to support Swagger1 Annotations (Annotate Model and Api using the Swagger Annotations 1.x library) could do so independently of Springfox using annotationLibrary=swagger1.
  • Shown in the command line help
  • Added to the generated documentation (spring.md)
  • Added to the generated README.md
  • Logged at WARNING level on each invocation.
PR checklist
  • [x ] Read the contribution guidelines.
  • [ x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [ x] Run the following to build the project and update samples:

    ./mvnw clean package ./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh

    
Commit all changed files.
    
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    
These must match the expectations made by your contribution.
    
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    
For Windows users, please run the script in Git BASH.
  • [ x] File the PR against the correct branch: master (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
- Upgrade swagger-ui to 4.4.1
9c1d423
- Bring homeController.mustache up-to-date
- Main class is now OpenApiGeneratorApplication
- Introduce SpringBootTest.mustache
- Remove option swaggerDocketConfig/openapiDocketConfig in favor of documentationProvider.
@cachescrubber
Generate Samples
97e847c
@cachescrubber
Restore generator-online classes
bbffdcd
Fix spring-mvc builds
@cachescrubber
Generate Samples
9c351da
@cachescrubber
Do not generate SpringFoxConfiguration.java when reactive ist set.
56a49a6
@cachescrubber
Fix generation of SpringFoxConfiguration
403852a
@cachescrubber
Generate Documentation
502587d
@cachescrubber
Reactive support: add dependency management for springdoc-openapi-web…
9e29c02
…flux-ui
@cachescrubber
Generate Samples
6b153a7
@cachescrubber
Change SpringBootApplication to OpenApiGeneratorApplication
6315747
@cachescrubber
Generate Samples
82b2f5d
@cachescrubber
Implement SwaggerUIFeatures in SpringCodegen
6ea78d1
@cachescrubber
Generate Samples
339cd54
@cachescrubber
Add useSwaggerUI: true to some test configs
730bdd1
@cachescrubber
Generate Samples
396ad6a
@cachescrubber
Update Documentation
9f63b42
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
re-open to trigger CI
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
There is a new spring-boot sample, spring-boot-source.yaml. It has should be registered as a new CI build.
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 , @welshm FYI
welshm
welshm
reviewed
Feb 6, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor comment - I think that interface only is not exclusive to swagger-ui
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
added this to the 6.0.0 milestone
Feb 8, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
30ba4d5
# Conflicts:
#	modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/openapi2SpringBoot.mustache
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/java-camel/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/.openapi-generator/FILES
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
@cachescrubber
Generate Samples
901cf29
@cachescrubber
Remove spring-mvc library
117edce
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Could you remove the sprng-mvc samples from the CI configuration?
Lars Uffmann
added 2 commits
February 10, 2022 08:50
Lars Uffmann
Merge branch 'master' into feature/sourceDocumentationProvider
87367b6
# Conflicts:
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
Lars Uffmann
Remove spring-mvc from project and CI configs
33101fe
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
Could you remove the sprng-mvc samples from the CI configuration?
I think I have done it with 87367b6. Please review.
welshm
welshm
approved these changes
Feb 11, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone requests the ability to generate the HTML with interfaces inky later, it's easy enough to reevaluate if that's a valid configuration we'd want to support.
Only other comment is about generating tests (I think there's a global generator property on whether or not tests should be output)
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
changed the title
Implement Source DocumentationProviderImplement Source DocumentationProvider, spring-mvc decomissinoFeb 12, 2022
@wing328wing328
changed the title
Implement Source DocumentationProvider, spring-mvc decomissinoImplement Source DocumentationProvider, spring-mvc decommissionFeb 12, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
a59adf1
# Conflicts:
#	samples/server/petstore/spring-mvc-default-value/src/main/java/org/openapitools/api/TestHeadersApi.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java
@cachescrubber
Generate samples
82eee37
@cachescrubber
Merge remote-tracking branch 'origin/feature/sourceDocumentationProvi…
7ca877b
…der' into feature/sourceDocumentationProvider
@cachescrubber
Generate samples
41c5027
@cachescrubber
Generate samples
ed761ac
@cachescrubber
cachescrubber
commented
Feb 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Circle-CI failures are not caused by this pr IMO.
@wing328
wing328
commented
Feb 12, 2022

Copy link


Copy Markdown

Member
CircleCI failures not related to this PR.
@wing328
wing328
merged commit 0ed147e
into
OpenAPITools:masterFeb 12, 2022
@cachescrubber
cachescrubber
deleted the

feature/sourceDocumentationProvider

branch
February 12, 2022 10:01
@cachescrubbercachescrubber
mentioned this pull request
Feb 12, 2022

Open

@sjoblomjsjoblomj
mentioned this pull request
Apr 20, 2022
 Merged

4 tasks
@boardtc
boardtc
commented
Jan 20, 2023•

edited

Loading

Copy link


Copy Markdown

fyi, Moving from 5.0.0 to 6.3.0-SNAPSHOT.a s suggested I tried spring-boot, but it does not recognise that library unless generatorName is set to spring
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments
@jimschubertjimschubertAwaiting requested review from jimschubert

+1 more reviewer

@welshmwelshmwelshm approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

DecommissionEnhancement: FeatureServer: JavaServer: Spring

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

4 participants

@cachescrubber@wing328@boardtc@welshm

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Implement Source DocumentationProvider, spring-mvc decommission - #11531
Merged
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Feb 12, 2022
Merged
Implement Source DocumentationProvider, spring-mvc decommission#11531
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Feb 5, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Finish the DocumentationProvider Story (#11258)
Changes
When source is selected as DocumentationProvider, the original openapi spec is copied to the project and

is exposed via /openapi.{json,yaml}. Swagger-ui, if enabled, is configured to show this spec.
  • SpringCodegen now implements SwaggerUIFeatures. Use the useSwaggerUI parameter with the spring-boot library to use it. Swagger UI is enabled by default.
  • Upgrade swagger-ui to 4.4.1 including a customised swagger-ui.html
  • The SpringBootApplication class is renamed to OpenApiGeneratorApplication.java.
  • Introduce SpringBootTest.mustache as OpenApiGeneratorApplicationTests.java.
  • Remove option openapiDocketConfig. Replaced by documentationProvider=springfox.
Deprecation Warnings
  • springfox (documentationProvider): Springfox is deprecated for removal in version 7.0.0 of openapi-generator. The project seems to be no longer maintained (last commit is of Oct 14, 2020). It works with Spring Boot 2.5.x but not with 2.6. Spring Boot 2.5 is supported until 2022-05-19. Users of openapi-generator should migrate to the springdoc documentation provider which is, as an added bonus, OpenAPI v3 compatible.
Removals
  • spring-mvc (Library): The Spring MVC library is going to be removed in version 6.0.0 of openapi-generator. Users should upgrade to the Spring Boot based library. Since the library is based on dependencies which are declared EOL (spring-framework 4.x) and we have no plans to move it forward, it has to be removed for security and maintenance reasons.
Users who need to support Swagger1 Annotations (Annotate Model and Api using the Swagger Annotations 1.x library) could do so independently of Springfox using annotationLibrary=swagger1.
  • Shown in the command line help
  • Added to the generated documentation (spring.md)
  • Added to the generated README.md
  • Logged at WARNING level on each invocation.
PR checklist
  • [x ] Read the contribution guidelines.
  • [ x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [ x] Run the following to build the project and update samples:

    ./mvnw clean package ./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh

    
Commit all changed files.
    
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    
These must match the expectations made by your contribution.
    
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    
For Windows users, please run the script in Git BASH.
  • [ x] File the PR against the correct branch: master (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
- Upgrade swagger-ui to 4.4.1
9c1d423
- Bring homeController.mustache up-to-date
- Main class is now OpenApiGeneratorApplication
- Introduce SpringBootTest.mustache
- Remove option swaggerDocketConfig/openapiDocketConfig in favor of documentationProvider.
@cachescrubber
Generate Samples
97e847c
@cachescrubber
Restore generator-online classes
bbffdcd
Fix spring-mvc builds
@cachescrubber
Generate Samples
9c351da
@cachescrubber
Do not generate SpringFoxConfiguration.java when reactive ist set.
56a49a6
@cachescrubber
Fix generation of SpringFoxConfiguration
403852a
@cachescrubber
Generate Documentation
502587d
@cachescrubber
Reactive support: add dependency management for springdoc-openapi-web…
9e29c02
…flux-ui
@cachescrubber
Generate Samples
6b153a7
@cachescrubber
Change SpringBootApplication to OpenApiGeneratorApplication
6315747
@cachescrubber
Generate Samples
82b2f5d
@cachescrubber
Implement SwaggerUIFeatures in SpringCodegen
6ea78d1
@cachescrubber
Generate Samples
339cd54
@cachescrubber
Add useSwaggerUI: true to some test configs
730bdd1
@cachescrubber
Generate Samples
396ad6a
@cachescrubber
Update Documentation
9f63b42
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
re-open to trigger CI
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
There is a new spring-boot sample, spring-boot-source.yaml. It has should be registered as a new CI build.
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 , @welshm FYI
welshm
welshm
reviewed
Feb 6, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor comment - I think that interface only is not exclusive to swagger-ui
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
added this to the 6.0.0 milestone
Feb 8, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
30ba4d5
# Conflicts:
#	modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/openapi2SpringBoot.mustache
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/java-camel/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/.openapi-generator/FILES
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
@cachescrubber
Generate Samples
901cf29
@cachescrubber
Remove spring-mvc library
117edce
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Could you remove the sprng-mvc samples from the CI configuration?
Lars Uffmann
added 2 commits
February 10, 2022 08:50
Lars Uffmann
Merge branch 'master' into feature/sourceDocumentationProvider
87367b6
# Conflicts:
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
Lars Uffmann
Remove spring-mvc from project and CI configs
33101fe
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
Could you remove the sprng-mvc samples from the CI configuration?
I think I have done it with 87367b6. Please review.
welshm
welshm
approved these changes
Feb 11, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone requests the ability to generate the HTML with interfaces inky later, it's easy enough to reevaluate if that's a valid configuration we'd want to support.
Only other comment is about generating tests (I think there's a global generator property on whether or not tests should be output)
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
changed the title
Implement Source DocumentationProviderImplement Source DocumentationProvider, spring-mvc decomissinoFeb 12, 2022
@wing328wing328
changed the title
Implement Source DocumentationProvider, spring-mvc decomissinoImplement Source DocumentationProvider, spring-mvc decommissionFeb 12, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
a59adf1
# Conflicts:
#	samples/server/petstore/spring-mvc-default-value/src/main/java/org/openapitools/api/TestHeadersApi.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java
@cachescrubber
Generate samples
82eee37
@cachescrubber
Merge remote-tracking branch 'origin/feature/sourceDocumentationProvi…
7ca877b
…der' into feature/sourceDocumentationProvider
@cachescrubber
Generate samples
41c5027
@cachescrubber
Generate samples
ed761ac
@cachescrubber
cachescrubber
commented
Feb 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Circle-CI failures are not caused by this pr IMO.
@wing328
wing328
commented
Feb 12, 2022

Copy link


Copy Markdown

Member
CircleCI failures not related to this PR.
@wing328
wing328
merged commit 0ed147e
into
OpenAPITools:masterFeb 12, 2022
@cachescrubber
cachescrubber
deleted the

feature/sourceDocumentationProvider

branch
February 12, 2022 10:01
@cachescrubbercachescrubber
mentioned this pull request
Feb 12, 2022

Open

@sjoblomjsjoblomj
mentioned this pull request
Apr 20, 2022
 Merged

4 tasks
@boardtc
boardtc
commented
Jan 20, 2023•

edited

Loading

Copy link


Copy Markdown

fyi, Moving from 5.0.0 to 6.3.0-SNAPSHOT.a s suggested I tried spring-boot, but it does not recognise that library unless generatorName is set to spring
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments
@jimschubertjimschubertAwaiting requested review from jimschubert

+1 more reviewer

@welshmwelshmwelshm approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

DecommissionEnhancement: FeatureServer: JavaServer: Spring

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

4 participants

@cachescrubber@wing328@boardtc@welshm

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Implement Source DocumentationProvider, spring-mvc decommission - #11531
Merged
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Feb 12, 2022
Merged
Implement Source DocumentationProvider, spring-mvc decommission#11531
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Feb 5, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Finish the DocumentationProvider Story (#11258)
Changes
When source is selected as DocumentationProvider, the original openapi spec is copied to the project and

is exposed via /openapi.{json,yaml}. Swagger-ui, if enabled, is configured to show this spec.
  • SpringCodegen now implements SwaggerUIFeatures. Use the useSwaggerUI parameter with the spring-boot library to use it. Swagger UI is enabled by default.
  • Upgrade swagger-ui to 4.4.1 including a customised swagger-ui.html
  • The SpringBootApplication class is renamed to OpenApiGeneratorApplication.java.
  • Introduce SpringBootTest.mustache as OpenApiGeneratorApplicationTests.java.
  • Remove option openapiDocketConfig. Replaced by documentationProvider=springfox.
Deprecation Warnings
  • springfox (documentationProvider): Springfox is deprecated for removal in version 7.0.0 of openapi-generator. The project seems to be no longer maintained (last commit is of Oct 14, 2020). It works with Spring Boot 2.5.x but not with 2.6. Spring Boot 2.5 is supported until 2022-05-19. Users of openapi-generator should migrate to the springdoc documentation provider which is, as an added bonus, OpenAPI v3 compatible.
Removals
  • spring-mvc (Library): The Spring MVC library is going to be removed in version 6.0.0 of openapi-generator. Users should upgrade to the Spring Boot based library. Since the library is based on dependencies which are declared EOL (spring-framework 4.x) and we have no plans to move it forward, it has to be removed for security and maintenance reasons.
Users who need to support Swagger1 Annotations (Annotate Model and Api using the Swagger Annotations 1.x library) could do so independently of Springfox using annotationLibrary=swagger1.
  • Shown in the command line help
  • Added to the generated documentation (spring.md)
  • Added to the generated README.md
  • Logged at WARNING level on each invocation.
PR checklist
  • [x ] Read the contribution guidelines.
  • [ x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [ x] Run the following to build the project and update samples:

    ./mvnw clean package ./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh

    
Commit all changed files.
    
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    
These must match the expectations made by your contribution.
    
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    
For Windows users, please run the script in Git BASH.
  • [ x] File the PR against the correct branch: master (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
- Upgrade swagger-ui to 4.4.1
9c1d423
- Bring homeController.mustache up-to-date
- Main class is now OpenApiGeneratorApplication
- Introduce SpringBootTest.mustache
- Remove option swaggerDocketConfig/openapiDocketConfig in favor of documentationProvider.
@cachescrubber
Generate Samples
97e847c
@cachescrubber
Restore generator-online classes
bbffdcd
Fix spring-mvc builds
@cachescrubber
Generate Samples
9c351da
@cachescrubber
Do not generate SpringFoxConfiguration.java when reactive ist set.
56a49a6
@cachescrubber
Fix generation of SpringFoxConfiguration
403852a
@cachescrubber
Generate Documentation
502587d
@cachescrubber
Reactive support: add dependency management for springdoc-openapi-web…
9e29c02
…flux-ui
@cachescrubber
Generate Samples
6b153a7
@cachescrubber
Change SpringBootApplication to OpenApiGeneratorApplication
6315747
@cachescrubber
Generate Samples
82b2f5d
@cachescrubber
Implement SwaggerUIFeatures in SpringCodegen
6ea78d1
@cachescrubber
Generate Samples
339cd54
@cachescrubber
Add useSwaggerUI: true to some test configs
730bdd1
@cachescrubber
Generate Samples
396ad6a
@cachescrubber
Update Documentation
9f63b42
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
re-open to trigger CI
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
There is a new spring-boot sample, spring-boot-source.yaml. It has should be registered as a new CI build.
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 , @welshm FYI
welshm
welshm
reviewed
Feb 6, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor comment - I think that interface only is not exclusive to swagger-ui
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
added this to the 6.0.0 milestone
Feb 8, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
30ba4d5
# Conflicts:
#	modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/openapi2SpringBoot.mustache
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/java-camel/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/.openapi-generator/FILES
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
@cachescrubber
Generate Samples
901cf29
@cachescrubber
Remove spring-mvc library
117edce
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Could you remove the sprng-mvc samples from the CI configuration?
Lars Uffmann
added 2 commits
February 10, 2022 08:50
Lars Uffmann
Merge branch 'master' into feature/sourceDocumentationProvider
87367b6
# Conflicts:
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
Lars Uffmann
Remove spring-mvc from project and CI configs
33101fe
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
Could you remove the sprng-mvc samples from the CI configuration?
I think I have done it with 87367b6. Please review.
welshm
welshm
approved these changes
Feb 11, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone requests the ability to generate the HTML with interfaces inky later, it's easy enough to reevaluate if that's a valid configuration we'd want to support.
Only other comment is about generating tests (I think there's a global generator property on whether or not tests should be output)
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
changed the title
Implement Source DocumentationProviderImplement Source DocumentationProvider, spring-mvc decomissinoFeb 12, 2022
@wing328wing328
changed the title
Implement Source DocumentationProvider, spring-mvc decomissinoImplement Source DocumentationProvider, spring-mvc decommissionFeb 12, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
a59adf1
# Conflicts:
#	samples/server/petstore/spring-mvc-default-value/src/main/java/org/openapitools/api/TestHeadersApi.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java
@cachescrubber
Generate samples
82eee37
@cachescrubber
Merge remote-tracking branch 'origin/feature/sourceDocumentationProvi…
7ca877b
…der' into feature/sourceDocumentationProvider
@cachescrubber
Generate samples
41c5027
@cachescrubber
Generate samples
ed761ac
@cachescrubber
cachescrubber
commented
Feb 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Circle-CI failures are not caused by this pr IMO.
@wing328
wing328
commented
Feb 12, 2022

Copy link


Copy Markdown

Member
CircleCI failures not related to this PR.
@wing328
wing328
merged commit 0ed147e
into
OpenAPITools:masterFeb 12, 2022
@cachescrubber
cachescrubber
deleted the

feature/sourceDocumentationProvider

branch
February 12, 2022 10:01
@cachescrubbercachescrubber
mentioned this pull request
Feb 12, 2022

Open

@sjoblomjsjoblomj
mentioned this pull request
Apr 20, 2022
 Merged

4 tasks
@boardtc
boardtc
commented
Jan 20, 2023•

edited

Loading

Copy link


Copy Markdown

fyi, Moving from 5.0.0 to 6.3.0-SNAPSHOT.a s suggested I tried spring-boot, but it does not recognise that library unless generatorName is set to spring
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments
@jimschubertjimschubertAwaiting requested review from jimschubert

+1 more reviewer

@welshmwelshmwelshm approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

DecommissionEnhancement: FeatureServer: JavaServer: Spring

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

4 participants

@cachescrubber@wing328@boardtc@welshm

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Implement Source DocumentationProvider, spring-mvc decommission - #11531
Merged
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Feb 12, 2022
Merged
Implement Source DocumentationProvider, spring-mvc decommission#11531
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Feb 5, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Finish the DocumentationProvider Story (#11258)
Changes
When source is selected as DocumentationProvider, the original openapi spec is copied to the project and

is exposed via /openapi.{json,yaml}. Swagger-ui, if enabled, is configured to show this spec.
  • SpringCodegen now implements SwaggerUIFeatures. Use the useSwaggerUI parameter with the spring-boot library to use it. Swagger UI is enabled by default.
  • Upgrade swagger-ui to 4.4.1 including a customised swagger-ui.html
  • The SpringBootApplication class is renamed to OpenApiGeneratorApplication.java.
  • Introduce SpringBootTest.mustache as OpenApiGeneratorApplicationTests.java.
  • Remove option openapiDocketConfig. Replaced by documentationProvider=springfox.
Deprecation Warnings
  • springfox (documentationProvider): Springfox is deprecated for removal in version 7.0.0 of openapi-generator. The project seems to be no longer maintained (last commit is of Oct 14, 2020). It works with Spring Boot 2.5.x but not with 2.6. Spring Boot 2.5 is supported until 2022-05-19. Users of openapi-generator should migrate to the springdoc documentation provider which is, as an added bonus, OpenAPI v3 compatible.
Removals
  • spring-mvc (Library): The Spring MVC library is going to be removed in version 6.0.0 of openapi-generator. Users should upgrade to the Spring Boot based library. Since the library is based on dependencies which are declared EOL (spring-framework 4.x) and we have no plans to move it forward, it has to be removed for security and maintenance reasons.
Users who need to support Swagger1 Annotations (Annotate Model and Api using the Swagger Annotations 1.x library) could do so independently of Springfox using annotationLibrary=swagger1.
  • Shown in the command line help
  • Added to the generated documentation (spring.md)
  • Added to the generated README.md
  • Logged at WARNING level on each invocation.
PR checklist
  • [x ] Read the contribution guidelines.
  • [ x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [ x] Run the following to build the project and update samples:

    ./mvnw clean package ./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh

    
Commit all changed files.
    
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    
These must match the expectations made by your contribution.
    
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    
For Windows users, please run the script in Git BASH.
  • [ x] File the PR against the correct branch: master (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
- Upgrade swagger-ui to 4.4.1
9c1d423
- Bring homeController.mustache up-to-date
- Main class is now OpenApiGeneratorApplication
- Introduce SpringBootTest.mustache
- Remove option swaggerDocketConfig/openapiDocketConfig in favor of documentationProvider.
@cachescrubber
Generate Samples
97e847c
@cachescrubber
Restore generator-online classes
bbffdcd
Fix spring-mvc builds
@cachescrubber
Generate Samples
9c351da
@cachescrubber
Do not generate SpringFoxConfiguration.java when reactive ist set.
56a49a6
@cachescrubber
Fix generation of SpringFoxConfiguration
403852a
@cachescrubber
Generate Documentation
502587d
@cachescrubber
Reactive support: add dependency management for springdoc-openapi-web…
9e29c02
…flux-ui
@cachescrubber
Generate Samples
6b153a7
@cachescrubber
Change SpringBootApplication to OpenApiGeneratorApplication
6315747
@cachescrubber
Generate Samples
82b2f5d
@cachescrubber
Implement SwaggerUIFeatures in SpringCodegen
6ea78d1
@cachescrubber
Generate Samples
339cd54
@cachescrubber
Add useSwaggerUI: true to some test configs
730bdd1
@cachescrubber
Generate Samples
396ad6a
@cachescrubber
Update Documentation
9f63b42
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
re-open to trigger CI
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
There is a new spring-boot sample, spring-boot-source.yaml. It has should be registered as a new CI build.
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 , @welshm FYI
welshm
welshm
reviewed
Feb 6, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor comment - I think that interface only is not exclusive to swagger-ui
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
added this to the 6.0.0 milestone
Feb 8, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
30ba4d5
# Conflicts:
#	modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/openapi2SpringBoot.mustache
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/java-camel/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/.openapi-generator/FILES
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
@cachescrubber
Generate Samples
901cf29
@cachescrubber
Remove spring-mvc library
117edce
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Could you remove the sprng-mvc samples from the CI configuration?
Lars Uffmann
added 2 commits
February 10, 2022 08:50
Lars Uffmann
Merge branch 'master' into feature/sourceDocumentationProvider
87367b6
# Conflicts:
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
Lars Uffmann
Remove spring-mvc from project and CI configs
33101fe
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
Could you remove the sprng-mvc samples from the CI configuration?
I think I have done it with 87367b6. Please review.
welshm
welshm
approved these changes
Feb 11, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone requests the ability to generate the HTML with interfaces inky later, it's easy enough to reevaluate if that's a valid configuration we'd want to support.
Only other comment is about generating tests (I think there's a global generator property on whether or not tests should be output)
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
changed the title
Implement Source DocumentationProviderImplement Source DocumentationProvider, spring-mvc decomissinoFeb 12, 2022
@wing328wing328
changed the title
Implement Source DocumentationProvider, spring-mvc decomissinoImplement Source DocumentationProvider, spring-mvc decommissionFeb 12, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
a59adf1
# Conflicts:
#	samples/server/petstore/spring-mvc-default-value/src/main/java/org/openapitools/api/TestHeadersApi.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java
@cachescrubber
Generate samples
82eee37
@cachescrubber
Merge remote-tracking branch 'origin/feature/sourceDocumentationProvi…
7ca877b
…der' into feature/sourceDocumentationProvider
@cachescrubber
Generate samples
41c5027
@cachescrubber
Generate samples
ed761ac
@cachescrubber
cachescrubber
commented
Feb 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Circle-CI failures are not caused by this pr IMO.
@wing328
wing328
commented
Feb 12, 2022

Copy link


Copy Markdown

Member
CircleCI failures not related to this PR.
@wing328
wing328
merged commit 0ed147e
into
OpenAPITools:masterFeb 12, 2022
@cachescrubber
cachescrubber
deleted the

feature/sourceDocumentationProvider

branch
February 12, 2022 10:01
@cachescrubbercachescrubber
mentioned this pull request
Feb 12, 2022

Open

@sjoblomjsjoblomj
mentioned this pull request
Apr 20, 2022
 Merged

4 tasks
@boardtc
boardtc
commented
Jan 20, 2023•

edited

Loading

Copy link


Copy Markdown

fyi, Moving from 5.0.0 to 6.3.0-SNAPSHOT.a s suggested I tried spring-boot, but it does not recognise that library unless generatorName is set to spring
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments
@jimschubertjimschubertAwaiting requested review from jimschubert

+1 more reviewer

@welshmwelshmwelshm approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

DecommissionEnhancement: FeatureServer: JavaServer: Spring

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

4 participants

@cachescrubber@wing328@boardtc@welshm

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Implement Source DocumentationProvider, spring-mvc decommission - #11531
Merged
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Feb 12, 2022
Merged
Implement Source DocumentationProvider, spring-mvc decommission#11531
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Feb 5, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Finish the DocumentationProvider Story (#11258)
Changes
When source is selected as DocumentationProvider, the original openapi spec is copied to the project and

is exposed via /openapi.{json,yaml}. Swagger-ui, if enabled, is configured to show this spec.
  • SpringCodegen now implements SwaggerUIFeatures. Use the useSwaggerUI parameter with the spring-boot library to use it. Swagger UI is enabled by default.
  • Upgrade swagger-ui to 4.4.1 including a customised swagger-ui.html
  • The SpringBootApplication class is renamed to OpenApiGeneratorApplication.java.
  • Introduce SpringBootTest.mustache as OpenApiGeneratorApplicationTests.java.
  • Remove option openapiDocketConfig. Replaced by documentationProvider=springfox.
Deprecation Warnings
  • springfox (documentationProvider): Springfox is deprecated for removal in version 7.0.0 of openapi-generator. The project seems to be no longer maintained (last commit is of Oct 14, 2020). It works with Spring Boot 2.5.x but not with 2.6. Spring Boot 2.5 is supported until 2022-05-19. Users of openapi-generator should migrate to the springdoc documentation provider which is, as an added bonus, OpenAPI v3 compatible.
Removals
  • spring-mvc (Library): The Spring MVC library is going to be removed in version 6.0.0 of openapi-generator. Users should upgrade to the Spring Boot based library. Since the library is based on dependencies which are declared EOL (spring-framework 4.x) and we have no plans to move it forward, it has to be removed for security and maintenance reasons.
Users who need to support Swagger1 Annotations (Annotate Model and Api using the Swagger Annotations 1.x library) could do so independently of Springfox using annotationLibrary=swagger1.
  • Shown in the command line help
  • Added to the generated documentation (spring.md)
  • Added to the generated README.md
  • Logged at WARNING level on each invocation.
PR checklist
  • [x ] Read the contribution guidelines.
  • [ x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [ x] Run the following to build the project and update samples:

    ./mvnw clean package ./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh

    
Commit all changed files.
    
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    
These must match the expectations made by your contribution.
    
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    
For Windows users, please run the script in Git BASH.
  • [ x] File the PR against the correct branch: master (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
- Upgrade swagger-ui to 4.4.1
9c1d423
- Bring homeController.mustache up-to-date
- Main class is now OpenApiGeneratorApplication
- Introduce SpringBootTest.mustache
- Remove option swaggerDocketConfig/openapiDocketConfig in favor of documentationProvider.
@cachescrubber
Generate Samples
97e847c
@cachescrubber
Restore generator-online classes
bbffdcd
Fix spring-mvc builds
@cachescrubber
Generate Samples
9c351da
@cachescrubber
Do not generate SpringFoxConfiguration.java when reactive ist set.
56a49a6
@cachescrubber
Fix generation of SpringFoxConfiguration
403852a
@cachescrubber
Generate Documentation
502587d
@cachescrubber
Reactive support: add dependency management for springdoc-openapi-web…
9e29c02
…flux-ui
@cachescrubber
Generate Samples
6b153a7
@cachescrubber
Change SpringBootApplication to OpenApiGeneratorApplication
6315747
@cachescrubber
Generate Samples
82b2f5d
@cachescrubber
Implement SwaggerUIFeatures in SpringCodegen
6ea78d1
@cachescrubber
Generate Samples
339cd54
@cachescrubber
Add useSwaggerUI: true to some test configs
730bdd1
@cachescrubber
Generate Samples
396ad6a
@cachescrubber
Update Documentation
9f63b42
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
re-open to trigger CI
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
There is a new spring-boot sample, spring-boot-source.yaml. It has should be registered as a new CI build.
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 , @welshm FYI
welshm
welshm
reviewed
Feb 6, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor comment - I think that interface only is not exclusive to swagger-ui
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
added this to the 6.0.0 milestone
Feb 8, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
30ba4d5
# Conflicts:
#	modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/openapi2SpringBoot.mustache
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/java-camel/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/.openapi-generator/FILES
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
@cachescrubber
Generate Samples
901cf29
@cachescrubber
Remove spring-mvc library
117edce
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Could you remove the sprng-mvc samples from the CI configuration?
Lars Uffmann
added 2 commits
February 10, 2022 08:50
Lars Uffmann
Merge branch 'master' into feature/sourceDocumentationProvider
87367b6
# Conflicts:
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
Lars Uffmann
Remove spring-mvc from project and CI configs
33101fe
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
Could you remove the sprng-mvc samples from the CI configuration?
I think I have done it with 87367b6. Please review.
welshm
welshm
approved these changes
Feb 11, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone requests the ability to generate the HTML with interfaces inky later, it's easy enough to reevaluate if that's a valid configuration we'd want to support.
Only other comment is about generating tests (I think there's a global generator property on whether or not tests should be output)
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
changed the title
Implement Source DocumentationProviderImplement Source DocumentationProvider, spring-mvc decomissinoFeb 12, 2022
@wing328wing328
changed the title
Implement Source DocumentationProvider, spring-mvc decomissinoImplement Source DocumentationProvider, spring-mvc decommissionFeb 12, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
a59adf1
# Conflicts:
#	samples/server/petstore/spring-mvc-default-value/src/main/java/org/openapitools/api/TestHeadersApi.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java
@cachescrubber
Generate samples
82eee37
@cachescrubber
Merge remote-tracking branch 'origin/feature/sourceDocumentationProvi…
7ca877b
…der' into feature/sourceDocumentationProvider
@cachescrubber
Generate samples
41c5027
@cachescrubber
Generate samples
ed761ac
@cachescrubber
cachescrubber
commented
Feb 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Circle-CI failures are not caused by this pr IMO.
@wing328
wing328
commented
Feb 12, 2022

Copy link


Copy Markdown

Member
CircleCI failures not related to this PR.
@wing328
wing328
merged commit 0ed147e
into
OpenAPITools:masterFeb 12, 2022
@cachescrubber
cachescrubber
deleted the

feature/sourceDocumentationProvider

branch
February 12, 2022 10:01
@cachescrubbercachescrubber
mentioned this pull request
Feb 12, 2022

Open

@sjoblomjsjoblomj
mentioned this pull request
Apr 20, 2022
 Merged

4 tasks
@boardtc
boardtc
commented
Jan 20, 2023•

edited

Loading

Copy link


Copy Markdown

fyi, Moving from 5.0.0 to 6.3.0-SNAPSHOT.a s suggested I tried spring-boot, but it does not recognise that library unless generatorName is set to spring
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments
@jimschubertjimschubertAwaiting requested review from jimschubert

+1 more reviewer

@welshmwelshmwelshm approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

DecommissionEnhancement: FeatureServer: JavaServer: Spring

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

4 participants

@cachescrubber@wing328@boardtc@welshm

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Implement Source DocumentationProvider, spring-mvc decommission - #11531
Merged
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Feb 12, 2022
Merged
Implement Source DocumentationProvider, spring-mvc decommission#11531
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Feb 5, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Finish the DocumentationProvider Story (#11258)
Changes
When source is selected as DocumentationProvider, the original openapi spec is copied to the project and

is exposed via /openapi.{json,yaml}. Swagger-ui, if enabled, is configured to show this spec.
  • SpringCodegen now implements SwaggerUIFeatures. Use the useSwaggerUI parameter with the spring-boot library to use it. Swagger UI is enabled by default.
  • Upgrade swagger-ui to 4.4.1 including a customised swagger-ui.html
  • The SpringBootApplication class is renamed to OpenApiGeneratorApplication.java.
  • Introduce SpringBootTest.mustache as OpenApiGeneratorApplicationTests.java.
  • Remove option openapiDocketConfig. Replaced by documentationProvider=springfox.
Deprecation Warnings
  • springfox (documentationProvider): Springfox is deprecated for removal in version 7.0.0 of openapi-generator. The project seems to be no longer maintained (last commit is of Oct 14, 2020). It works with Spring Boot 2.5.x but not with 2.6. Spring Boot 2.5 is supported until 2022-05-19. Users of openapi-generator should migrate to the springdoc documentation provider which is, as an added bonus, OpenAPI v3 compatible.
Removals
  • spring-mvc (Library): The Spring MVC library is going to be removed in version 6.0.0 of openapi-generator. Users should upgrade to the Spring Boot based library. Since the library is based on dependencies which are declared EOL (spring-framework 4.x) and we have no plans to move it forward, it has to be removed for security and maintenance reasons.
Users who need to support Swagger1 Annotations (Annotate Model and Api using the Swagger Annotations 1.x library) could do so independently of Springfox using annotationLibrary=swagger1.
  • Shown in the command line help
  • Added to the generated documentation (spring.md)
  • Added to the generated README.md
  • Logged at WARNING level on each invocation.
PR checklist
  • [x ] Read the contribution guidelines.
  • [ x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [ x] Run the following to build the project and update samples:

    ./mvnw clean package ./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh

    
Commit all changed files.
    
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    
These must match the expectations made by your contribution.
    
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    
For Windows users, please run the script in Git BASH.
  • [ x] File the PR against the correct branch: master (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
- Upgrade swagger-ui to 4.4.1
9c1d423
- Bring homeController.mustache up-to-date
- Main class is now OpenApiGeneratorApplication
- Introduce SpringBootTest.mustache
- Remove option swaggerDocketConfig/openapiDocketConfig in favor of documentationProvider.
@cachescrubber
Generate Samples
97e847c
@cachescrubber
Restore generator-online classes
bbffdcd
Fix spring-mvc builds
@cachescrubber
Generate Samples
9c351da
@cachescrubber
Do not generate SpringFoxConfiguration.java when reactive ist set.
56a49a6
@cachescrubber
Fix generation of SpringFoxConfiguration
403852a
@cachescrubber
Generate Documentation
502587d
@cachescrubber
Reactive support: add dependency management for springdoc-openapi-web…
9e29c02
…flux-ui
@cachescrubber
Generate Samples
6b153a7
@cachescrubber
Change SpringBootApplication to OpenApiGeneratorApplication
6315747
@cachescrubber
Generate Samples
82b2f5d
@cachescrubber
Implement SwaggerUIFeatures in SpringCodegen
6ea78d1
@cachescrubber
Generate Samples
339cd54
@cachescrubber
Add useSwaggerUI: true to some test configs
730bdd1
@cachescrubber
Generate Samples
396ad6a
@cachescrubber
Update Documentation
9f63b42
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
re-open to trigger CI
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
There is a new spring-boot sample, spring-boot-source.yaml. It has should be registered as a new CI build.
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 , @welshm FYI
welshm
welshm
reviewed
Feb 6, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor comment - I think that interface only is not exclusive to swagger-ui
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
added this to the 6.0.0 milestone
Feb 8, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
30ba4d5
# Conflicts:
#	modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/openapi2SpringBoot.mustache
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/java-camel/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/.openapi-generator/FILES
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
@cachescrubber
Generate Samples
901cf29
@cachescrubber
Remove spring-mvc library
117edce
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Could you remove the sprng-mvc samples from the CI configuration?
Lars Uffmann
added 2 commits
February 10, 2022 08:50
Lars Uffmann
Merge branch 'master' into feature/sourceDocumentationProvider
87367b6
# Conflicts:
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
Lars Uffmann
Remove spring-mvc from project and CI configs
33101fe
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
Could you remove the sprng-mvc samples from the CI configuration?
I think I have done it with 87367b6. Please review.
welshm
welshm
approved these changes
Feb 11, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone requests the ability to generate the HTML with interfaces inky later, it's easy enough to reevaluate if that's a valid configuration we'd want to support.
Only other comment is about generating tests (I think there's a global generator property on whether or not tests should be output)
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
changed the title
Implement Source DocumentationProviderImplement Source DocumentationProvider, spring-mvc decomissinoFeb 12, 2022
@wing328wing328
changed the title
Implement Source DocumentationProvider, spring-mvc decomissinoImplement Source DocumentationProvider, spring-mvc decommissionFeb 12, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
a59adf1
# Conflicts:
#	samples/server/petstore/spring-mvc-default-value/src/main/java/org/openapitools/api/TestHeadersApi.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java
@cachescrubber
Generate samples
82eee37
@cachescrubber
Merge remote-tracking branch 'origin/feature/sourceDocumentationProvi…
7ca877b
…der' into feature/sourceDocumentationProvider
@cachescrubber
Generate samples
41c5027
@cachescrubber
Generate samples
ed761ac
@cachescrubber
cachescrubber
commented
Feb 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Circle-CI failures are not caused by this pr IMO.
@wing328
wing328
commented
Feb 12, 2022

Copy link


Copy Markdown

Member
CircleCI failures not related to this PR.
@wing328
wing328
merged commit 0ed147e
into
OpenAPITools:masterFeb 12, 2022
@cachescrubber
cachescrubber
deleted the

feature/sourceDocumentationProvider

branch
February 12, 2022 10:01
@cachescrubbercachescrubber
mentioned this pull request
Feb 12, 2022

Open

@sjoblomjsjoblomj
mentioned this pull request
Apr 20, 2022
 Merged

4 tasks
@boardtc
boardtc
commented
Jan 20, 2023•

edited

Loading

Copy link


Copy Markdown

fyi, Moving from 5.0.0 to 6.3.0-SNAPSHOT.a s suggested I tried spring-boot, but it does not recognise that library unless generatorName is set to spring
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments
@jimschubertjimschubertAwaiting requested review from jimschubert

+1 more reviewer

@welshmwelshmwelshm approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

DecommissionEnhancement: FeatureServer: JavaServer: Spring

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

4 participants

@cachescrubber@wing328@boardtc@welshm

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Implement Source DocumentationProvider, spring-mvc decommission - #11531
Merged
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Feb 12, 2022
Merged
Implement Source DocumentationProvider, spring-mvc decommission#11531
wing328 merged 37 commits into
OpenAPITools:masterfrom 
cachescrubber:feature/sourceDocumentationProvider
Conversation
@cachescrubber
@cachescrubbercachescrubber
commented
Feb 5, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Finish the DocumentationProvider Story (#11258)
Changes
When source is selected as DocumentationProvider, the original openapi spec is copied to the project and

is exposed via /openapi.{json,yaml}. Swagger-ui, if enabled, is configured to show this spec.
  • SpringCodegen now implements SwaggerUIFeatures. Use the useSwaggerUI parameter with the spring-boot library to use it. Swagger UI is enabled by default.
  • Upgrade swagger-ui to 4.4.1 including a customised swagger-ui.html
  • The SpringBootApplication class is renamed to OpenApiGeneratorApplication.java.
  • Introduce SpringBootTest.mustache as OpenApiGeneratorApplicationTests.java.
  • Remove option openapiDocketConfig. Replaced by documentationProvider=springfox.
Deprecation Warnings
  • springfox (documentationProvider): Springfox is deprecated for removal in version 7.0.0 of openapi-generator. The project seems to be no longer maintained (last commit is of Oct 14, 2020). It works with Spring Boot 2.5.x but not with 2.6. Spring Boot 2.5 is supported until 2022-05-19. Users of openapi-generator should migrate to the springdoc documentation provider which is, as an added bonus, OpenAPI v3 compatible.
Removals
  • spring-mvc (Library): The Spring MVC library is going to be removed in version 6.0.0 of openapi-generator. Users should upgrade to the Spring Boot based library. Since the library is based on dependencies which are declared EOL (spring-framework 4.x) and we have no plans to move it forward, it has to be removed for security and maintenance reasons.
Users who need to support Swagger1 Annotations (Annotate Model and Api using the Swagger Annotations 1.x library) could do so independently of Springfox using annotationLibrary=swagger1.
  • Shown in the command line help
  • Added to the generated documentation (spring.md)
  • Added to the generated README.md
  • Logged at WARNING level on each invocation.
PR checklist
  • [x ] Read the contribution guidelines.
  • [ x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [ x] Run the following to build the project and update samples:

    ./mvnw clean package ./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh

    
Commit all changed files.
    
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    
These must match the expectations made by your contribution.
    
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    
For Windows users, please run the script in Git BASH.
  • [ x] File the PR against the correct branch: master (5.3.0), 6.0.x
  • [ x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@cachescrubber
- Upgrade swagger-ui to 4.4.1
9c1d423
- Bring homeController.mustache up-to-date
- Main class is now OpenApiGeneratorApplication
- Introduce SpringBootTest.mustache
- Remove option swaggerDocketConfig/openapiDocketConfig in favor of documentationProvider.
@cachescrubber
Generate Samples
97e847c
@cachescrubber
Restore generator-online classes
bbffdcd
Fix spring-mvc builds
@cachescrubber
Generate Samples
9c351da
@cachescrubber
Do not generate SpringFoxConfiguration.java when reactive ist set.
56a49a6
@cachescrubber
Fix generation of SpringFoxConfiguration
403852a
@cachescrubber
Generate Documentation
502587d
@cachescrubber
Reactive support: add dependency management for springdoc-openapi-web…
9e29c02
…flux-ui
@cachescrubber
Generate Samples
6b153a7
@cachescrubber
Change SpringBootApplication to OpenApiGeneratorApplication
6315747
@cachescrubber
Generate Samples
82b2f5d
@cachescrubber
Implement SwaggerUIFeatures in SpringCodegen
6ea78d1
@cachescrubber
Generate Samples
339cd54
@cachescrubber
Add useSwaggerUI: true to some test configs
730bdd1
@cachescrubber
Generate Samples
396ad6a
@cachescrubber
Update Documentation
9f63b42
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
re-open to trigger CI
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
There is a new spring-boot sample, spring-boot-source.yaml. It has should be registered as a new CI build.
@cachescrubber
cachescrubber
commented
Feb 6, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 , @welshm FYI
welshm
welshm
reviewed
Feb 6, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor comment - I think that interface only is not exclusive to swagger-ui
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
added this to the 6.0.0 milestone
Feb 8, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
30ba4d5
# Conflicts:
#	modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/openapi2SpringBoot.mustache
#	samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/java-camel/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-beanvalidation-no-nullable/.openapi-generator/FILES
#	samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
#	samples/server/petstore/springboot-spring-pageable-without-j8/.openapi-generator/FILES
#	samples/server/petstore/springboot-spring-pageable-without-j8/src/main/java/org/openapitools/OpenAPI2SpringBoot.java
@cachescrubber
Generate Samples
901cf29
@cachescrubber
Remove spring-mvc library
117edce
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
@wing328 Could you remove the sprng-mvc samples from the CI configuration?
Lars Uffmann
added 2 commits
February 10, 2022 08:50
Lars Uffmann
Merge branch 'master' into feature/sourceDocumentationProvider
87367b6
# Conflicts:
#	modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java
Lars Uffmann
Remove spring-mvc from project and CI configs
33101fe
@cachescrubber
cachescrubber
commented
Feb 10, 2022

Copy link


Copy Markdown

ContributorAuthor
Could you remove the sprng-mvc samples from the CI configuration?
I think I have done it with 87367b6. Please review.
welshm
welshm
approved these changes
Feb 11, 2022
View reviewed changes
@welshmwelshm
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone requests the ability to generate the HTML with interfaces inky later, it's easy enough to reevaluate if that's a valid configuration we'd want to support.
Only other comment is about generating tests (I think there's a global generator property on whether or not tests should be output)
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java
@wing328wing328
changed the title
Implement Source DocumentationProviderImplement Source DocumentationProvider, spring-mvc decomissinoFeb 12, 2022
@wing328wing328
changed the title
Implement Source DocumentationProvider, spring-mvc decomissinoImplement Source DocumentationProvider, spring-mvc decommissionFeb 12, 2022
@cachescrubber
Merge branch 'master' into feature/sourceDocumentationProvider
a59adf1
# Conflicts:
#	samples/server/petstore/spring-mvc-default-value/src/main/java/org/openapitools/api/TestHeadersApi.java
#	samples/server/petstore/spring-mvc-j8-async/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-j8-localdatetime/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-no-nullable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc-spring-pageable/src/main/java/org/openapitools/api/FakeApi.java
#	samples/server/petstore/spring-mvc/src/main/java/org/openapitools/api/FakeApi.java
@cachescrubber
Generate samples
82eee37
@cachescrubber
Merge remote-tracking branch 'origin/feature/sourceDocumentationProvi…
7ca877b
…der' into feature/sourceDocumentationProvider
@cachescrubber
Generate samples
41c5027
@cachescrubber
Generate samples
ed761ac
@cachescrubber
cachescrubber
commented
Feb 12, 2022

Copy link


Copy Markdown

ContributorAuthor
Circle-CI failures are not caused by this pr IMO.
@wing328
wing328
commented
Feb 12, 2022

Copy link


Copy Markdown

Member
CircleCI failures not related to this PR.
@wing328
wing328
merged commit 0ed147e
into
OpenAPITools:masterFeb 12, 2022
@cachescrubber
cachescrubber
deleted the

feature/sourceDocumentationProvider

branch
February 12, 2022 10:01
@cachescrubbercachescrubber
mentioned this pull request
Feb 12, 2022

Open

@sjoblomjsjoblomj
mentioned this pull request
Apr 20, 2022
 Merged

4 tasks
@boardtc
boardtc
commented
Jan 20, 2023•

edited

Loading

Copy link


Copy Markdown

fyi, Moving from 5.0.0 to 6.3.0-SNAPSHOT.a s suggested I tried spring-boot, but it does not recognise that library unless generatorName is set to spring
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wing328wing328wing328 left review comments
@jimschubertjimschubertAwaiting requested review from jimschubert

+1 more reviewer

@welshmwelshmwelshm approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

DecommissionEnhancement: FeatureServer: JavaServer: Spring

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

4 participants

@cachescrubber@wing328@boardtc@welshm