Repository files navigation

Opinionated APIs for web & mobile applications.

Read this in other languages:中文.

• Background
• Documentation
• Install
• Usage
• Security
• Contribute
• License

Elide is a Java library that lets you setup model drivenGraphQL orJSON API web service with minimal effort. Elide supports two variants of APIs:

1. A CRUD (Create, Read, Update, Delete) API for reading and manipulating models.
2. An analytic API for aggregating measures over zero or more model attributes.

Elide supports a number of features:

Control access to fields and entities through a declarative, intuitive permission syntax.

JSON-API & GraphQL lets developers fetch entire object graphs in a single round trip. Only requested elements of the data model are returned.Our opinionated approach for mutations addresses common application scenarios:

• Create a new object and add it to an existing collection in the same operation.
• Create a set of related, composite objects (a subgraph) and connect it to an existing, persisted graph.
• Differentiate between deleting an object vs disassociating an object from a relationship (but not deleting it).
• Change the composition of a relationship to something different.
• Reference a newly created object inside other mutation operations.

Filtering, sorting, pagination, and text search are supported out of the box.

Elide supports multiple data model mutations in a single request in either JSON-API or GraphQL. Create objects, add them to relationships, modify or delete together in a single atomic request.

Elide supports analytic queries against models crafted with its powerful semantic layer. Elide APIs work natively withYavin to visualize, explore, and report on your data.

Explore, understand, and compose queries against your Elide API through generated Swagger documentation or GraphQL schema.

Customize the behavior of data model operations with computed attributes, data validation annotations, and request lifecycle hooks.

Elide is agnostic to your particular persistence strategy. Use an ORM or provide your own implementation of a data store.

More information about Elide can be found atelide.io.

To try out an Elide example service, check out thisSpring boot example project.

Alternatively, useelide-standalone which allows you to quickly setup a local instance of Elide running inside an embedded Jetty application.

The simplest way to use Elide is by leveragingJPA to map your Elide models to persistence:

The models should represent the domain model of your web service:

@EntitypublicclassBook {@IdprivateIntegerid;privateStringtitle;@ManyToMany(mappedBy ="books")privateSet<Author>authors;}

Add Elide annotations to both expose your models through the web service and define security policies for access:

@Entity@Include(rootLevel =true)@ReadPermission("Everyone")@CreatePermission("Admin OR Publisher")@DeletePermission("None")@UpdatePermission("None")publicclassBook {@IdprivateIntegerid;@UpdatePermission("Admin OR Publisher")privateStringtitle;@ManyToMany(mappedBy ="books")privateSet<Author>authors;}

Add Lifecycle hooks to your models to embed custom business logic that execute inline with CRUD operations through the web service:

@Entity@Include(rootLevel =true)@ReadPermission("Everyone")@CreatePermission("Admin OR Publisher")@DeletePermission("None")@UpdatePermission("None")@LifeCycleHookBinding(operation =UPDATE,hook =BookCreationHook.class,phase =PRECOMMIT)publicclassBook {@IdprivateIntegerid;@UpdatePermission("Admin OR Publisher")privateStringtitle;@ManyToMany(mappedBy ="books")privateSet<Author>authors;}publicclassBookCreationHookimplementsLifeCycleHook<Book> {@Overridepublicvoidexecute(LifeCycleHookBinding.Operationoperation,LifeCycleHookBinding.TransactionPhasephase,Bookbook,RequestScoperequestScope,Optional<ChangeSpec>changes) {//Do something    }}

Map expressions to security functions or predicates that get pushed to the persistence layer:

@SecurityCheck("Admin")publicstaticclassIsAdminUserextendsUserCheck {@Overridepublicbooleanok(Useruser) {returnisUserInRole(user,UserRole.admin);        }    }

To expose and query these models, follow the steps documented inthe getting started guide.

For example API calls, look at:

1. JSON-API
2. GraphQL

Analytic models including tables, measures, dimensions, and joins can be created either as POJOs or with a friendly HJSON configuration language:

{  tables: [    {      name: Orders      table: order_details      measures: [        {          name: orderTotal          type: DECIMAL          definition: 'SUM({{$order_total}})'        }      ]      dimensions: [        {          name: orderId          type: TEXT          definition: '{{$order_id}}'        }      ]    }  ]}

More information on configuring or querying analytic models can be foundhere.

Security is documented in depthhere.

Please refer tothe contributing.md file for information about how to get involved. We welcome issues, questions, and pull requests.

If you are contributing to Elide using an IDE, such as IntelliJ, make sure to install theLombok plugin.

Community chat is now ondiscord. Join by clickinghere.Legacy discussion is archived onspectrum.

This project is licensed under the terms of theApache 2.0 open source license.Please refer toLICENSE for the full terms.

Intro to Elide video

Create a JSON API REST Service With Spring Boot and Elide

Custom Security With a Spring Boot/Elide Json API Server

Logging Into a Spring Boot/Elide JSON API Server

Securing a JSON API REST Service With Spring Boot and Elide

Creating Entities in a Spring Boot/Elide JSON API Server

Updating and Deleting with a Spring Boot/Elide JSON API Server