如何解决REST API的继承和子对象的使用
我正在使用resteasy
构建REST API,并且在此处应用继承时遇到了一些麻烦。因此,让我解释一下。
我有一个名为/parties
的端点。在应用程序中有2种类型的参与方。个人和组织。不能更改为使用2个不同的资源,它被设计为对两个资源都使用资源parties
。
我创建了3个模型,分别为PartyModel
,IndividualModel
和OrganizationModel
。 IndividualModel
和OrganizationModel
是PartyModel
的子级。同时PartyModel
是IdentifiableEntity
的子代。后者是几乎所有模型都使用的通用类别。
这些是模型。我省略了吸气剂和吸气剂:
可识别实体
public class IdentifiableEntity {
@ApiModelProperty(example = "9eeb19e7-62e7-4fdb-8a99-fb77e51dda0a",value = "The unique,technical identifier")
@JsonProperty("uuId")
@Pattern(regexp="[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}")
private String uuId;
}
PartyModel
public class PartyModel extends IdentifiableEntity {
@ApiModelProperty(value = "Discriminator for the type of party")
@JsonProperty("partyType")
@NotNull
private PartyTypeEnum partyType;
}
个人模型
public class IndividualModel extends PartyModel {
@ApiModelProperty(value = "")
@JsonProperty("individualName")
private IndividualName individualName;
@ApiModelProperty(value = "")
@JsonProperty("company")
private OrganizationModel company;
}
组织模型
public class OrganizationModel extends PartyModel {
@ApiModelProperty(example = "VF",value = "")
@JsonProperty("mnemonic")
private String mnemonic;
@ApiModelProperty(example = "Vodafone",value = "A short,commonly used name of the organization")
@JsonProperty("shortName")
private String shortName;
@ApiModelProperty(value = "")
@JsonProperty("organizationName")
private OrganizationName organizationName = null;
}
这是我的控制者:
PartiesApi
@Path("/parties")
@Api(description = "the parties API")
public class PartiesApi {
@Inject
private PartiesApiService service;
@POST
@Consumes({ "application/json" })
@Produces({ "application/json" })
@ApiOperation(value = "Create Party",notes = "Creates a new party. The uuId may be client provided,otherwise one is generated. If a client provided uuId is already in use,a 409 error code will be returned.",response = Object.class,tags={ })
@ApiResponses(value = {
@ApiResponse(code = 200,message = "The created party.",response = Object.class),@ApiResponse(code = 400,message = "The request was not understood. Additional information may be available in the included ApiError",response = ApiError.class),@ApiResponse(code = 409,message = "There is a conflict with the resource that does not allow the service to process the request as sent. The request may work if repeated later or if the resource is modified beforehand. Additional information may be available in the included ApiError",@ApiResponse(code = 500,message = "An internal error occured. The request should not be repeated. Additional information may be available in the included ApiError",response = ApiError.class) })
public Response createParty(@ApiParam(value = "The party to create" ) PartyModel body,@ApiParam(value = "The authorization scheme and credentials. Supported schemes: Bearer (via Keycloak). The parameter is not technically required but all requests without it (exception for OPTIONS requests) will result in a 401 - Unauthorized response" )@HeaderParam("Authorization") String authorization,@Context SecurityContext securityContext)
throws Exception {
PartyModel partySaved = service.createParty(body,authorization,securityContext);
return Response.ok(partySaved).build();
}
}
这是服务:
PartyServiceImpl
@RequestScoped
@Stateful
public class PartiesApiServiceImpl implements PartiesApiService {
@Inject
private PartyRepositoryIface partyRepository;
@Inject
private PartyMapper partyMapper;
public PartyModel createParty(PartyModel partyToSave,String authorization,SecurityContext securityContext) throws ApiException {
//The UUID was not given in the request. Therefore we generate it randomly.
if(Objects.isNull(partyToSave.getUuId()) || partyToSave.getUuId().isEmpty()){
partyToSave.setUuId(UUID.randomUUID().toString());
}
PartyEntity partyEntityToSave = partyMapper.dtoToEntity(partyToSave);
//An exception will be thrown in case the party to save already exists. Based on the UUID
Optional<PartyEntity> partyEntitySaved = partyRepository.save(partyRepository.findById(partyEntityToSave.getUuid()).orElseThrow(() -> new ApiException(HttpStatus.SC_CONFLICT,"This party already exists")));
return partyMapper.entityToDto(partyEntitySaved.get());
}
}
因此,当我尝试发送INVIDUAL作为请求时,我的问题就出现了。我需要访问其属性private OrganizationModel company
以便对其进行一些逻辑处理。但是,由于我传递了PartyModel
作为参数,因此无法直接访问。我宁愿避免对对象进行强制转换或使用instanceof
。
在这里和互联网中,我已经检查了许多与REST API继承相关的主题,但是都没有弄清我的问题。
因此,我该如何处理?
如何使用Party
作为请求的父类,但是能够根据模型是Individual
还是Organization
对模型进行逻辑处理?版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。