从 Java -> swagger 生成 UI model

Question

• I can use

   <dependency> <groupId>io.swagger.codegen.v3</groupId> <artifactId>swagger-codegen-maven-plugin</artifactId> <version>${swagger-codegen-maven-plugin.version}</version> </dependency>

  to create UI (typescript) and BE (java) models from swagger-ui.yml file (manually written) - I
  do NOT want swagger to generate endpoints (I want to write them in java).
• I can also access new swagger file at runtime with springfox-swagger2 + springfox-swagger- ui
  (2.9.2)

   <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>

I want to write everything in Java (models and endpoints), then somehow generate swagger-ui.yml from java , and then generate typescript models from that swagger-ui.yml file (like i can with swagger.codegen), though I was unsuccessfull with combining these two approaches. Or is there some other way (other dependencies etc) to do this? I also need the swagger file to include endpoints documentation, like using springfox-swagger-ui. (I am using maven, spring-boot-starter-web, java 8, angular13)

Answer 1

The idea is that swagger will give you the "Api" endpoints (as interfaces) and you will write the "Api Implementation" in java.

For example, from your swagger-ui.yml file:

Your MyappApi class might look like this:

@Api(description = "the myapp API")
@javax.annotation.Generated(...)public interface MyappApi {
... endpoints go here
}

And then you write MyappApiImpl like this:

public class MyappApiImpl implements MyappApi {
... override methods here
}

Not that its very important the typescript classes and java Api endpoints are kept in sync. You do not want to hand write everything in java - let swagger define the API implementation (server side, for java) and you define the implementations only.