Skip to content
GitLab

[Spring] Fix generated api ignore basePath

Merged Administrator requested to merge github/fork/RomainPruvostMHH/fix_issue1928 into master

Created by: RomainPruvostMHH

Fix #1928 (closed)

The base-path should be set on the Api interface. This way it is working with interfaceOnly. And it's compliant with Spring documentation : https://www.baeldung.com/spring-interface-driven-controllers

Changes

  • I removed it from the apiController.mustache file and added it to the api.mustache file
  • I moved the defaultBasePath.mustache file in src/main/resources/JavaSpring so that it's common with all Spring server-side libraries (spring-boot, spring-mvc, spring-cloud (see the notice below for spring-cloud) ). The value of default context path is the value of contextPath variable.
  • I added a unit test to verify it

Refactoring

  • I updated the outputDir variable to samples/server/petstore/spring-stubs in the bin/configs/spring-stubs.yaml file because it generates Spring server-side classes. And not on the client-side as the output directory seemed to suggest. I deleted the old samples/client/petstore/spring-stubs directory.

Notice

  • Some files are updated in the samples/client/petstore/spring-cloud* directories. Actually, the spring-cloud library isn't consistent. Both server-side and client-side files are generated. That's why all generated xxxApi.java files in samples/client/petstore/spring-cloud directories are updated with this fix too.

PR checklist

  • Read the contribution guidelines.
  • 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.
  • 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.
  • File the PR against the correct branch: master (5.3.0), 6.0.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.

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @nmuesch (2021/01)