[JAXRS-CXF] Re-added usage of contextPath in api.mustache (basePath)

[markus-wa]

PR checklist

• Read the contribution guildelines.
• Ran the shell/batch script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates)
• Filed the PR against the correct branch: master for non-breaking changes and 2.3.0 branch for breaking (non-backward compatible) changes.

Description of the PR

Fix for #4569 - basePath was ignored for jaxrs-cxf

[wing328]

@markus-wa Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/swagger-api/swagger-codegen/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/swagger-api/swagger-codegen/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

[wing328]

@jfiala please take a look at this PR when you've time.

[markus-wa]

I have added the email from the commit to my github account.

[jfiala]

@wing328 I removed this when I reworked the cxf template, because using the basePath in the @path is not the usual configuration for CXF.
CXF uses spring and the basePath is configured in web.xml/spring configuration files:

@markus-wa
Please take a look at the generated web.xml file (with config generateSpringApplication=true)

<servlet-mapping>
        <servlet-name>CXFServiceServlet</servlet-name>
        <url-pattern>/rest/*</url-pattern>
    </servlet-mapping>

There the servlet mapping is done.

The next step is the JAXRS-server which is configured in Spring (see ApplicationContext.xml):

<jaxrs:server id="restServer" address="/services">

With these two configurations the services are now located at

http://<servername>/<appcontext-name>/rest/services/<myservices>

The JAXRS @path(..) in the interface is always connected to the root ("/"), as there are already two other places where you can configure the servlet-mapping and the jaxrs:server-endpoint.

This is how I worked with the cxf language so far, other usages usually caused troubles with other features, so that was the most stable and also understandable solution to start with.

If you simply need the basePath in @path, I'd suggest to customize the template (but I wonder then how you are doing servlet-mapping/jaxrs-endpoint configuration in spring) or if you think it makes really sense for the cxf-language, please also submit how the spring configuration should change in your opinion and verify all the features work (including swagger-ui, Swagger2Feature etc.), so pls test then with all the CLI flags turned on.

@wing328
So right now, pls don't merge, as the CXF server stub will no longer work then as designed/expected.

[markus-wa]

Until now we have been using a single CxfNonSpringServlet for multiple services with different basePaths. The @path seems to be the only option in this case as far as I'm aware.

I will get back to you with more details - maybe a command line option might be the way to go?

[jfiala]

@markus-wa I'm green with the CLI option, in fact the solution you proposed seems the cleaner way in JaxRS terms (contract -> jaxrs interface). You can also provide an alternative to the spring configuration I did by supporting a flag for the CxfNonSpringServlet, this would make it complete. Pls let me know if you need assistance in powering up the cxf language support...

[jfiala]

@markus-wa great, this looks good!

[jfiala]

for the generated samples, you generated them with the CLI flag useAnnotatedBasePath turned on. In fact we would need a separate sample for all off (=default), one with all spring flags turned on and one with the generateNonSpringServlet turned on. @wing328 pls can you advise here how we should handle this in your opinion?

[markus-wa]

Woops, what happened here? https://travis-ci.org/swagger-api/swagger-codegen/jobs/195578396

[wing328]

@markus-wa I just pushed a fix to the latest master. Pls pull the latest to give it a try.

[wing328]

@wing328 pls can you advise here how we should handle this in your opinion?

A good starting is by looking at the following 2 shell scripts:
spring-delegate-j8.sh
spring-delegate.sh

The differences are the output folder (samples/server/petstore/springboot-delegate-j8) and the additional option (java8=true).

For your case, you can do something similar with the additional option generateNonSpringServlet.

If you want, I can do it later after merging this PR into master.

[markus-wa]

@jfiala @wing328 I've added the sample generation, let me know if i missed something.

[wing328]

@markus-wa I've resolved the merge conflicts and merge the changes into master. Thanks for your contribution.