Resource structure
Overview
The expandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact. generate . Though the HTTP protocol that carries REST is standardized and uniquely defined as described in RFC 7231 and amended with the PATCH method described in RFC 5789, the REST payloads themselves are not. As such, a set of commonly used specifications and practices were adopted to provide a clean implementation.
The following specifications are used to generate a consistent and clean API which is self-documenting:
- The HAL (Hypertext Application Language) specification to return lists of resources, accompanied by navigation data and search metrics.
- The Problem Details specification to describe errors in a meaningful and consistent way.
- The OpenAPI (or Swagger) v3.0 specification for documenting RESTful APIs.
In additions to these specifications, the expandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact. generate Swagger UI integration to provide a clean and visual interface to the API for developers and users of the applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution..
Expansion resources
The following expansion resourcesExpansion Resource (ExpansionResource). A reusable resource bundle containing expanders and features that provide specific application capabilities, defined in the expansion settings and added to the classpath during expansion. are available for use in applicationsApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution.:
org.normalizedsystems.beam:service-api-beam@1.3.2: A beam that contains all resources for the jaxrs-service-api-expanders, which can be combined with other beams.net.democritus.api.rest:jaxrs-service-api-expanders@5.7.0: The main expander bundle, which expands the JAX-RS REST stack into the main NS application stack.net.democritus.api.rest:jaxrs-service-api-account-security-expanders@5.7.0: An addon expander bundle for therest-expandersbundle, which adds support for the access control features in theaccountcomponent of thebase-components.net.democritus.api.rest:jaxrs-service-api-assets-expanders@5.7.0: An addon expander bundle for therest-expandersbundle, which supplies an implementation for file resources and upload/download endpoints with theassetscomponent of thebase-components.
A development preview bundle is available for the jaxrs-service-api-expandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact.. This is a mirror of the service-api-beam, but containing the latest versions of all resources.
This resource is not intended for use in applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. development, but rather to preview upcoming changes and test against them in advance. Note that this preview bundle is subject to changes and does not necessarily reflect the future state of the service-api-beam.