elide Descargar - Descarga del código fuente de elide

elide

Datos del sitio web

7.1.4

Descargar

Elidir

API obstinadas para aplicaciones web y móviles.

Lea esto en otros idiomas: 中文.

Tabla de contenido

Fondo
Documentación
Instalar
Uso
Seguridad
Contribuir
Licencia

Fondo

Elide es una biblioteca de Java que le permite configurar el servicio web GraphQL o API JSON con el modelo con un esfuerzo mínimo. Elide admite dos variantes de API:

Una API crud (crear, leer, actualizar, eliminar) para leer y manipular modelos.
Una API analítica para agregar medidas sobre cero o más atributos del modelo.

Elide admite una serie de características:

La seguridad viene de serie

Controle el acceso a campos y entidades a través de una sintaxis de permiso declarativo e intuitivo.

API para dispositivos móviles

JSON-API y Graphql permite a los desarrolladores obtener gráficos de objetos completos en un solo ida y vuelta. Solo se devuelven elementos solicitados del modelo de datos. Nuestro enfoque obstinado para mutaciones aborda escenarios de aplicación común:

Cree un nuevo objeto y agréguelo a una colección existente en la misma operación.
Cree un conjunto de objetos compuestos relacionados (un subgrafio) y conecte a un gráfico persistido existente.
Diferenciar entre eliminar un objeto frente a disociar un objeto de una relación (pero no eliminarlo).
Cambie la composición de una relación a algo diferente.
Referencia a un objeto recién creado dentro de otras operaciones de mutación.

El filtrado, la clasificación, la paginación y la búsqueda de texto son compatibles con el cuadro.

Atomicidad para escrituras complejas

Elide admite múltiples mutaciones del modelo de datos en una sola solicitud en JSON-API o GraphQL. Cree objetos, agréguelos a las relaciones, modifique o elimine juntos en una sola solicitud atómica.

Soporte de consulta analítica

Elide admite consultas analíticas contra modelos diseñados con su poderosa capa semántica. Elide API trabaja de forma nativa con Yavin para visualizar, explorar e informar sobre sus datos.

Introspección del esquema

Explore, comprenda y componga consultas contra su API Elide a través de la documentación de arrogancia generada o el esquema GraphQL.

Personalizar

Personalice el comportamiento de las operaciones del modelo de datos con atributos calculados, anotaciones de validación de datos y solicite ganchos de ciclo de vida.

Agnóstico de almacenamiento

Elide es agnóstico para su estrategia de persistencia particular. Use un ORM o proporcione su propia implementación de un almacén de datos.

Documentación

Puede encontrar más información sobre Elide en Elide.io.

Instalar

Para probar un servicio de ejemplo de Elide, consulte el proyecto Elide-Spring-Boot-Ejemplo.

Alternativamente, use el proyecto Elide-standalone-examen que le permite configurar rápidamente una instancia local de Elide que se ejecuta dentro de una aplicación de embarcadero integrado.

Uso

Para las API crud

La forma más sencilla de usar Elide es aprovechando a JPA para asignar sus modelos Elide a la persistencia:

Los modelos deben representar el modelo de dominio de su servicio web:

 @ Entity
public class Book {

    @ Id
    private Integer id ;

    private String title ;

    @ ManyToMany ( mappedBy = "books" )
    private Set < Author > authors ;
}

Agregue anotaciones Elide para exponer sus modelos a través del servicio web y defina las políticas de seguridad para el acceso:

 @ Entity
@ Include ( rootLevel = true )
@ ReadPermission ( "Everyone" )
@ CreatePermission ( "Admin OR Publisher" )
@ DeletePermission ( "None" )
@ UpdatePermission ( "None" )
public class Book {

    @ Id
    private Integer id ;

    @ UpdatePermission ( "Admin OR Publisher" )
    private String title ;

    @ ManyToMany ( mappedBy = "books" )
    private Set < Author > authors ;
}

Agregue los ganchos de ciclo de vida a sus modelos para incorporar la lógica comercial personalizada que ejecute en línea con operaciones CRUD a través del servicio web:

 @ Entity
@ Include ( rootLevel = true )
@ ReadPermission ( "Everyone" )
@ CreatePermission ( "Admin OR Publisher" )
@ DeletePermission ( "None" )
@ UpdatePermission ( "None" )
@ LifeCycleHookBinding ( operation = UPDATE , hook = BookCreationHook . class , phase = PRECOMMIT )
public class Book {

    @ Id
    private Integer id ;

    @ UpdatePermission ( "Admin OR Publisher" )
    private String title ;

    @ ManyToMany ( mappedBy = "books" )
    private Set < Author > authors ;
}

public class BookCreationHook implements LifeCycleHook < Book > {
    @ Override
    public void execute ( LifeCycleHookBinding . Operation operation ,
                        LifeCycleHookBinding . TransactionPhase phase ,
                        Book book ,
                        RequestScope requestScope ,
                        Optional < ChangeSpec > changes ) {
       //Do something
    }
}

Mapear expresiones a funciones de seguridad o predicados que se llevan a la capa de persistencia:

 @ SecurityCheck ( "Admin" )
public static class IsAdminUser extends UserCheck {
    @ Override
    public boolean ok ( User user ) {
        return isUserInRole ( user , UserRole . admin );
    }
}

Para exponer y consultar estos modelos, siga los pasos documentados en la Guía Getting Start.

Por ejemplo, las llamadas de API, mira:

Json-api
Gráfico

Para API analíticas

Los modelos analíticos que incluyen tablas, medidas, dimensiones y uniones se pueden crear como POjos o con un lenguaje de configuración HJSON amigable:

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

Puede encontrar más información sobre la configuración o consulta de modelos analíticos aquí.