1

我正在使用 swagger-maven-plugin(kongchen) 生成静态文档，我想生成这样的 yaml：

swagger: "2.0"
info:
  version: "1.0.0"
  title: "Swagger example"
paths:
  /api/students:
    post:
      operationId: "addStudent"
      parameters:
      - in: "body"
        name: "body"
        required: false
        schema:
          $ref: "#/definitions/Student"
      responses:
        200:
          description: "successful operation"
          schema:
            type: "boolean"
definitions:
  Student:
    type: "object"
    properties:
      id:
        type: "integer"
        format: "int32"
        minimum: 1
        maximum: 20
      name:
        type: "string"
      surname:
        type: "string"

但我也希望插件包含未在我的控制器中定义的类。

我的插件设置：

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>com.github.kongchen</groupId>
                <artifactId>swagger-maven-plugin</artifactId>
                <version>3.1.8</version>
                <configuration>
                    <apiSources>
                        <apiSource>
                            <springmvc>true</springmvc>
                            <locations>
                                <location>
                                    mypackage
                                </location>
                            </locations>
                            <info>
                                <title>
                                    Swagger example
                                </title>
                                <version>
                                    1.0.0
                                </version>
                            </info>
                            <outputFormats>json,yaml</outputFormats>
                            <swaggerDirectory>generated</swaggerDirectory>
                            <swaggerApiReader>com.github.kongchen.swagger.docgen.reader.SpringMvcApiReader</swaggerApiReader>
                        </apiSource>
                    </apiSources>
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <dependencies>
                    <!-- Adding dependency to swagger-hibernate-validations to enable the BeanValidator as a custom
                         model converter -->
                    <dependency>
                        <groupId>io.swagger</groupId>
                        <artifactId>swagger-hibernate-validations</artifactId>
                        <version>1.5.6</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

有没有办法使用 Swagger 来实现这个目标？它的主要目标是拥有可以导入到 Apicurio 并在我的应用程序中使用的 yaml。

或者，也许有任何方法可以生成包含所有此类的 yaml，而无需在任何控制器中使用它？

 @ApiModel
    public class Student {
        @Min(1)
        @Max(20)
        @ApiModelProperty
        private int id;
        @ApiModelProperty
        private String name;}
4

2 回答 2

0

您的意思是包括模型、请求/响应存根吗？如果是这样，您可以使用 Swagger 注释

方法级别：

@ApiOperation(value = "Get Details", response = ResponseClassStub, produces = MediaType.APPLICATION_JSON_VALUE)
于 2020-09-21T11:51:05.900 回答
0

micronaut.openapi 可以包含 yml 文件。例如，如果您在 中有一个 openapi 模式openapi/mySchema.yml，则可以通过在 中输入以下行来将其导入您的模式openapi.properties：

micronaut.openapi.additional.files=openapi

不幸的是，如果您需要使用该类，这种方法不起作用。您可以单独定义一个类，但您需要手动使其与 mySchema.yml 保持同步。

于 2021-10-04T14:58:04.003 回答