Module Apipie
In: lib/generators/apipie/views_generator.rb
lib/generators/apipie/install/install_generator.rb
lib/apipie/dsl_definition.rb
lib/apipie/param_description.rb
lib/apipie/client/generator.rb
lib/apipie/middleware/checksum_in_headers.rb
lib/apipie/static_dispatcher.rb
lib/apipie/configuration.rb
lib/apipie/version.rb
lib/apipie/routing.rb
lib/apipie/apipie_module.rb
lib/apipie/method_description.rb
lib/apipie/application.rb
lib/apipie/markup.rb
lib/apipie/routes_formatter.rb
lib/apipie/error_description.rb
lib/apipie/errors.rb
lib/apipie/extractor.rb
lib/apipie/see_description.rb
lib/apipie/resource_description.rb
lib/apipie/helpers.rb
lib/apipie/validator.rb
lib/apipie/railtie.rb
lib/apipie/extractor/collector.rb
lib/apipie/extractor/recorder.rb
lib/apipie/extractor/writer.rb

Middleware for rails app that adds checksum of JSON in the response headers which can help client to realize when JSON has changed

Add the following to your application.rb

  require 'apipie/middleware/checksum_in_headers'
  # Add JSON checksum in headers for smarter caching
  config.middleware.use "Apipie::Middleware::ChecksumInHeaders"

And in your apipie initializer allow checksum calculation

  Apipie.configuration.update_checksum = true

and reload documentation

  Apipie.reload_documentation

By default the header is added to requests on /api and /apipie only It can be changed with

  Apipie.configuration.checksum_path = ['/prefix/api']

If set to nil the header is added always

Methods

Classes and Modules

Module Apipie::Client
Module Apipie::DSL
Module Apipie::Extractor
Module Apipie::Helpers
Module Apipie::Markup
Module Apipie::Middleware
Module Apipie::Routing
Module Apipie::Validator
Class Apipie::Application
Class Apipie::Configuration
Class Apipie::DefinedParamError
Class Apipie::Error
Class Apipie::ErrorDescription
Class Apipie::FileHandler
Class Apipie::InstallGenerator
Class Apipie::MethodDescription
Class Apipie::ParamDescription
Class Apipie::ParamError
Class Apipie::ParamInvalid
Class Apipie::ParamMissing
Class Apipie::Railtie
Class Apipie::ResourceDescription
Class Apipie::RoutesFormatter
Class Apipie::SeeDescription
Class Apipie::StaticDispatcher
Class Apipie::UnknownParam
Class Apipie::ViewsGenerator

Constants

VERSION = '0.4.0'

Public Class methods

get application description for given or default version

[Validate]