RonRatovsky
StaffJoined 10 years ago
User Profile
Staff
User Widgets
Contributions
Re: Swager codegen for spring boot: how is swagger-ui page generated
Hi Christophe, I'm trying to follow the details of your question, but a bit confused by the details. This answer may not be complete, but please feel free to follow up with details I might have missed. Both Springdoc and Springfox are third party libraries with which we cannot directly help. We simply don't have the technical knowledge of them to provide such support. If you encounter any issues dealing with them directly, you should file tickets in their github repositories. Swagger UI is indeed our tool. We don't provide a direct way of integrating it with Java projects, but at the end of the day, it's just a static set of files that need to be hosted with your app. To clarify, HTML is not being generated as a static file, but rather Swagger UI is a JavaScript based application that reads your API definition (Swagger 2.0 or OpenAPI 3.0) and renders it. Springfox does provide a webjar of Swagger UI and you'll need to check their docs on how to include it. If you want to use Swagger UI directly, you can find instructions here.722Views1like0CommentsRe: Super beginner question :)
It depends on the version of the codegen that you use (which depends on the version of specification you use). You can take a look at https://github.com/swagger-api/swagger-codegen#modifying-the-client-library-format and the following header to learn how to customize the codegen. There *are* html/js templates, but they may not suit your needs. However, you can take a look at them and use them as a baseline.1.2KViews3likes1CommentRe: distribute multiple Endpoints over multiple maven modules and make Swagger detect them
Since you've mentioned Spring, I assume you use Springfox. Springfox is not one of our projects and we're not familiar with it enough to provide support for it. Your best bet is to file a ticket with the project.910Views1like0CommentsRe: Security annotation does not seem to prevent the controller action from being executed
Hi Antonio, Not exactly sure what is the piece of documentation you're sharing, as it's not a fully valid OpenAPI definition. I assume from the code that you're using PHP's Symfony (not familiar with it at all, personally). Swagger UI will simply follow the OpenAPI definition it is provided with. If there's an issue with the code not adhering to the security requirements, you'd need to look into the code/framework you're using. Since we don't have any PHP libraries of our own, I'm afraid we can't help you with finding the solution.1.1KViews2likes0CommentsRe: Super beginner question :)
Very valid question. Generally speaking, you can use code generators like Swagger Codegen to automate the process of creating boilerplate code. Note that the existing templates may not address your needs out of the box. However, since the templates are highly customizable, you can simply modify them to your own needs and keep using them.1.2KViews2likes3CommentsRe: Spec'ing an endpoint that returns different responses depending on params sent
At the moment, the OpenAPI does not allow separating responses based on query parameters. There should be an open issue for it at https://github.com/OAI/OpenAPI-Specification/, though I can't find it at the moment.1.2KViews2likes2Comments