首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >我已经用openapi生成器-maven-plugin生成了我的API服务器,现在呢?

我已经用openapi生成器-maven-plugin生成了我的API服务器,现在呢?
EN

Stack Overflow用户
提问于 2020-02-25 20:53:11
回答 1查看 11.1K关注 0票数 1

我一定是遗漏了一些显而易见的东西是我的墓志铭。我创建了一个swagger2.0doc来表示一个简单的API。它有一个POST操作,返回一个Integer。我在Spring项目中使用openapi生成器-maven- plugin插件生成控制器、模型等。

如何创建一个控制器来处理请求?

/work-queue-api/target/generated-sources/openapi/src/main/java中,我看到了3件事。ApiUtil.javaWorkItemApi.java (接口),WorkItemApiController.java (实现)

我在我的应用程序中创建了一个实现WorkItemApiController的新控制器。但是当我这样做的时候,Spring抱怨说它的方法已经被映射了。

API“工作”,因为我可以启动它并使用Swagger发布。但是很明显,请求并没有得到实际处理,并且返回了一个默认响应。生成的接口粘贴在下面。它有一个实现方法。我希望能够在这种方法中调用服务。或者重写它的方法。

下面是为WorkItemApi生成的接口

代码语言:javascript
运行
复制
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech) (4.0.2).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
package com.etisoftware.work_queue.webapi.controller.v1;

import com.etisoftware.work_queue.webapi.model.v1.Error;
import com.etisoftware.work_queue.webapi.model.v1.NewWorkItem;
import com.etisoftware.work_queue.webapi.model.v1.WorkItemResponse;
import io.swagger.annotations.*;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RequestPart;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.multipart.MultipartFile;

import javax.validation.Valid;
import javax.validation.constraints.*;
import java.util.List;
import java.util.Map;
import java.util.Optional;

@Validated
@Api(value = "WorkItem", description = "the WorkItem API")
public interface WorkItemApi {

    default Optional<NativeWebRequest> getRequest() {
        return Optional.empty();
    }

    @ApiOperation(value = "Adds a new workItem", nickname = "v1WorkItemsPost", notes = "", response = WorkItemResponse.class, tags={ "workItem", })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = WorkItemResponse.class),
        @ApiResponse(code = 201, message = "Successful operation", response = WorkItemResponse.class),
        @ApiResponse(code = 400, message = "Bad Request", response = Error.class),
        @ApiResponse(code = 401, message = "Unauthorized"),
        @ApiResponse(code = 403, message = "Forbidden", response = Error.class),
        @ApiResponse(code = 404, message = "Not Found"),
        @ApiResponse(code = 500, message = "Internal server error", response = Error.class) })
    @RequestMapping(value = "/v1/work-items",
        produces = { "application/problem+json", "application/json" }, 
        consumes = { "application/json" },
        method = RequestMethod.POST)
    default ResponseEntity<WorkItemResponse> v1WorkItemsPost(@ApiParam(value = "Parameters to represent a new work item." ,required=true )  @Valid @RequestBody NewWorkItem newWorkItem) {
        getRequest().ifPresent(request -> {
            for (MediaType mediaType: MediaType.parseMediaTypes(request.getHeader("Accept"))) {
                if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) {
                    ApiUtil.setExampleResponse(request, "application/json", "{  \"controllerWorkNumber\" : 0.8008281904610115}");
                    break;
                }
            }
        });
        return new ResponseEntity<>(HttpStatus.valueOf(200));

    }

}

pom.xml中的插件配置

代码语言:javascript
运行
复制
<plugin>
        <groupId>org.openapitools</groupId>
        <artifactId>openapi-generator-maven-plugin</artifactId>
        <version>4.0.2</version>
        <executions>
          <execution>
            <goals>
              <goal>generate</goal>
            </goals>
            <configuration>
              <inputSpec>${project.basedir}/src/main/resources/swagger.yaml</inputSpec>
              <generatorName>spring</generatorName>
              <addCompileSourceRoot>true</addCompileSourceRoot>
              <configOptions>
                <basePackage>com.etisoftware.work_queue</basePackage>
                <configPackage>
                  com.etisoftware.work_queue.webapi.configuration
                </configPackage>
                <apiPackage>
                  com.etisoftware.work_queue.webapi.controller.v1
                </apiPackage>
                <modelPackage>
                  com.etisoftware.work_queue.webapi.model.v1
                </modelPackage>
                <invokerPackage>
                  com.etisoftware.work_queue
                </invokerPackage>
                <swaggerDocketConfig>true</swaggerDocketConfig>
                <useOptional>true</useOptional>
                <returnSuccessCode>true</returnSuccessCode>
                <useTags>true</useTags>
                <virtualService>false</virtualService>
                <dateLibrary>java8</dateLibrary>
                <hideGenerationTimestamp>true</hideGenerationTimestamp>
              </configOptions>
            </configuration>
          </execution>
        </executions>
      </plugin>
EN

回答 1

Stack Overflow用户

发布于 2020-02-26 16:23:22

解决方案是,我使用的是一个较早版本的插件。版本4.2.3包括了排除生成控制器的配置选项,这正是我所需要的。

代码语言:javascript
运行
复制
      <plugin>
        <groupId>org.openapitools</groupId>
        <artifactId>openapi-generator-maven-plugin</artifactId>
        <version>4.2.3</version>
        <executions>
          <execution>
            <goals>
              <goal>generate</goal>
            </goals>
            <configuration>
              <inputSpec>${project.basedir}/src/main/resources/swagger.yaml</inputSpec>
              <generatorName>spring</generatorName>
              <addCompileSourceRoot>true</addCompileSourceRoot>
              <configOptions>
                <basePackage>com.etisoftware.work_queue</basePackage>
                <configPackage>
                  com.etisoftware.work_queue.webapi.configuration
                </configPackage>
                <apiPackage>
                  com.etisoftware.work_queue.webapi.controller.v1
                </apiPackage>
                <modelPackage>
                  com.etisoftware.work_queue.webapi.model.v1
                </modelPackage>
                <invokerPackage>
                  com.etisoftware.work_queue
                </invokerPackage>
                <swaggerDocketConfig>true</swaggerDocketConfig>
                <useOptional>true</useOptional>
                <returnSuccessCode>true</returnSuccessCode>
                <useTags>true</useTags>
                <virtualService>false</virtualService>
                <dateLibrary>java8</dateLibrary>
                <hideGenerationTimestamp>true</hideGenerationTimestamp>
                <interfaceOnly>true</interfaceOnly>
                <skipDefaultInterface>true</skipDefaultInterface>
              </configOptions>
            </configuration>
          </execution>
        </executions>
      </plugin>

我提供的一个快速启动提示是,在第一代,允许插件生成控制器。然后,您可以从接口中提取所有注释,并将其放入您自己的控制器中。然后清理项目,在没有控制器的情况下重新生成源。

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/60402966

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档