annon_api v0.16.2 API Reference
Modules
This is an entry point of Annon application
This module defines the test case to be used by acceptance tests. It can allow run tests in async when each SQL.Sandbox connection will be binded to a specific test
This module implements Annons cache invalidation based on different cluster discovery strategies
The boundary for the API Configurations system
Adapter for API Gateway configuration loaders
Adapter to access cache using RDBMS
Adapter to access cache using ETS
This module is responsible for configuration lookups for each request
The boundary for the Plugin Configurations system
Main repository for DB that stores configuration
Schema for API’s entity
Schema for Plugins settings
This module defines the test case to be used by tests that require setting up a connection
This module defines the setup for tests requiring access to the application’s data layer
This module lists Configuration-related factories, a mean suitable for tests that involve preparation of DB data
This module lists Requests-related factories, a mean suitable for tests that involve preparation of DB data
Connection helpers
Helpers for working with IP addresses
This is a helper module for dispatching requests
This plugin invalidates Annons cache whenever there was change done by a Management API
REST interface that allows to manage API’s and their settings
REST interface that allows to manage Plugins and their settings
REST interface that allows to fetch dictionary data
This controller provides action functions for monitoring endpoints
REST interface that allows to fetch and delete stored requests
This router is used in controllers of Annons management API
Functions related to paging
Use this helpers when you want to render result in a controllers
Router for a Annons Management API
This supervisor manages endpoints for management API
This module provides functions to collects status from all nodes in Annon cluster
This module provides helper functions to persist meaningful metrics to StatsD or DogstatsD servers
This module provider path generation helpers for various entities in Management API
This helper provides abstract interface to define plugin
This module provides JSON Schema validator for a plugin settings
This module inject Plugins pipeline into Plug.Router
This module provides structure that goes trough Plugins execution pipeline
This module provides struct and utils to build upstream requests
Validation rules for ACL plugin settings
This plugin authenticates API consumers by using a configured strategy
Validation helpers for Auth plugin
JWT adapter for Auth strategies
JWT adapter for Auth strategies
Behaviour module for Auth strategies
Behaviour module for Auth strategies
This plugin controls cross-origin resource sharing
Validation helpers for CORS plugin
Validation rules for IPRestriction plugin settings
This plugin stores reqests and responses in Logger
database.
It is enabled by default and can not be disabled without rebuilding Annon container
This plugin measures or receives performance metrics from other parts of Annon and sends them to StatsD server
Proxy - is a core plugin that sends incoming request to an upstream back-ends
HTTP(s) requests adapter that sends body as-is via HTTPPoison
Validation rules for Proxy plugin settings
This plugin redirects insecure connections to HTTPS endpoint and setting HSTS headers
It allows to white/black-list consumers by user agent
Validation rules for UARestriction plugin settings
JSON Schema Validation plugin allows you to set validation rules for a path relative to an API
Validation rules for Validator plugin settings
This module defines struct to carry API consumer,
Router for a Annons public API
PublicAPI supervisor manages opened HTTP and HTTP ports for API Gateway
Nice way to apply migrations inside a released application
This module provides base Requests analytic data based on stored data
The boundary for the Requests Log system
This module provides interface to synchronously or asynchronously create Log Entries
This repo is used to store request and responses
Schema for Requests Log
A plug to allow concurrent, transactional acceptance tests with Annon.Requests module