elide Download - elide Source Code Скачать

elide

Данные веб-сайта

7.1.4

Скачать

Элид

Участие API для веб -и мобильных приложений.

Прочитайте это на других языках: 中文.

Фон

Elide - это библиотека Java, которая позволяет настроить модель, управляемую GraphQL или JSON API, с минимальными усилиями. Элид поддерживает два варианта API:

API CRUD (создать, читать, обновить, удалить) для чтения и манипулирования моделями.
Аналитический API для агрегирования мер по нулю или более атрибутам модели.

Элид поддерживает ряд функций:

Безопасность поступает в стандартной комплектации

Контрольный доступ к полям и объектам через декларативный, интуитивно понятный синтаксис разрешений.

Мобильные API

JSON-API & GRAPHQL позволяет разработчикам приносить целые графики объектов в одну обратную поездку. Только запрашиваемые элементы модели данных возвращаются. Наш самоуверенный подход к мутациям рассматривает общие сценарии применения:

Создайте новый объект и добавьте его в существующую коллекцию в той же операции.
Создайте набор связанных составных объектов (подграфа) и подключите его к существующему, сохранившемуся графику.
Различать удаление объекта против отделения объекта из отношений (но не удалять его).
Измените композицию отношений на что -то другое.
Ссылка на недавно созданный объект внутри других операций мутации.

Фильтрация, сортировка, лиц и текстовый поиск поддерживаются из коробки.

Атомность для комплекса пишет

Elide поддерживает несколько мутаций модели данных в одном запросе в JSON-API или GraphQL. Создайте объекты, добавьте их в отношения, изменяйте или удаляйте вместе в одном атомном запросе.

Аналитическая поддержка запроса

Элид поддерживает аналитические запросы против моделей, созданных с его мощным семантическим слоем. Elide API -интерфейс работают с Явином, чтобы визуализировать, исследовать и сообщать о ваших данных.

Схема самоанализ

Исследуйте, понимайте и составьте запросы против вашего API Elide с помощью сгенерированной документации Swagger или схемы GraphQL.

Настраивать

Настройте поведение операций модели данных с помощью вычисленных атрибутов, аннотаций валидации данных и запрашивания жизненного цикла.

Хранение агностик

Elide является агностикой для вашей конкретной стратегии настойчивости. Используйте ORM или предоставьте собственную реализацию хранилища данных.

Документация

Более подробную информацию об Elide можно найти на Elide.io.

Установить

Чтобы попробовать сервис Elide, ознакомьтесь с проектом Elide-Spring-Boot-Boot-Example.

В качестве альтернативы используйте проект Elide-Standalone-пример, который позволяет быстро настроить локальный экземпляр Elide, работающего внутри встроенного приложения.

Использование

Для Crud API

Самый простой способ использования Elide - это использовать JPA для сопоставления ваших моделей Elide на стойкость:

Модели должны представлять доменную модель вашего веб -службы:

 @ Entity
public class Book {

    @ Id
    private Integer id ;

    private String title ;

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

Добавьте аннотации Elide, чтобы как разоблачить ваши модели через веб -сервис, так и определить политики безопасности для доступа:

 @ 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 ;
}

Добавьте крючки для жизненного цикла к вашим моделям, чтобы внедрить пользовательскую бизнес -логику, которая выполняет встроенные с операциями CRUD через веб -сервис:

 @ 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
    }
}

Выражения карты функций безопасности или предикатов, которые подталкиваются к слою постоянства:

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

Чтобы разоблачить и запрашивать эти модели, выполните шаги, документированные в руководстве по началу работы.

Например, API вызовы, посмотрите на:

Json-api
Graphql

Для аналитических API

Аналитические модели, включая таблицы, измерения, измерения и соединения, могут быть созданы либо в виде POJOS, либо с дружественным языком конфигурации HJSON:

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

Более подробную информацию о настройке или запросе аналитических моделей можно найти здесь.

Безопасность

Безопасность здесь задокументирована.

Способствовать

Пожалуйста, обратитесь к файлу Anforming.md для получения информации о том, как принять участие. Мы приветствуем проблемы, вопросы и запросы.

Если вы участвуете в Elide, используя IDE, например, IntelliJ, обязательно установите плагин Lombok.

Общественный чат сейчас находится в раздоре. Присоединяйтесь, нажав здесь.

Лицензия

Этот проект лицензирован в соответствии с условиями лицензии Apache 2.0 с открытым исходным кодом. Пожалуйста, обратитесь к лицензии на полные условия.