intridea/grape
An opinionated micro-framework for creating REST-like APIs in Ruby. – Read the documentation
This page shows an evaluation of the documentation of intridea/grape.
Each class, module, method, etc. is given a grade based on how complete the docs are.
The bar above shows the distribution of these grades.
| Seems really good | ||
|---|---|---|
|
A
|
Grape::API.do_not_route_options! |
|
|
A
|
Grape::API.do_not_route_head! |
|
|
A
|
Grape::API.route |
|
|
A
|
Grape::Util::HashStack#get |
|
|
A
|
Grape::Endpoint |
|
| Show 54 more ... | ||
|
A
|
Grape::API |
|
|
A
|
Grape::Util::HashStack#set |
|
|
A
|
Grape::API.helpers |
|
|
A
|
Grape |
|
|
A
|
Grape::Middleware::Versioner::AcceptVersionHeader |
|
|
A
|
Grape::Validations::SingleOptionValidator |
|
|
A
|
Grape::Middleware::Versioner::Header |
|
|
A
|
Grape::Middleware::Versioner::Param |
|
|
A
|
Grape::Middleware::Versioner::Path |
|
|
A
|
Grape::Util::HashStack#initialize |
|
|
A
|
Grape::Validations::ClassMethods |
|
|
A
|
Grape::Middleware::Auth::OAuth2 |
|
|
A
|
Grape::Validations::Validator |
|
|
A
|
Grape::Util::HashStack#gather |
|
|
A
|
Grape::Util::HashStack#push |
|
|
A
|
Grape::Util::HashStack#peek |
|
|
A
|
Grape::Cookies#initialize |
|
|
A
|
Grape::Middleware::Filter |
|
|
A
|
Grape::Endpoint#cookies |
|
|
A
|
Grape::Util::HashStack |
|
|
A
|
Grape::Endpoint#route |
|
|
A
|
Grape::API#initialize |
|
|
A
|
Grape::API::Helpers |
|
|
A
|
Grape::Route |
|
|
A
|
Grape::API.route_param |
|
|
A
|
Hash#deep_merge |
|
|
A
|
Grape::Util::HashStack#update |
|
|
A
|
Grape::Util::HashStack#stack |
|
|
A
|
Grape::Endpoint#endpoints |
|
|
A
|
Grape::Endpoint#redirect |
|
|
A
|
Grape::API.content_types |
|
|
A
|
Grape::Endpoint#version |
|
|
A
|
Grape::Endpoint#status |
|
|
A
|
Grape::API.http_basic |
|
|
A
|
Grape::API.middleware |
|
|
A
|
Grape::API.routes |
|
|
A
|
Grape::API.imbue |
|
|
A
|
Grape::API.set |
|
|
A
|
Grape::Middleware::Base#before |
|
|
A
|
Grape::Middleware::Base#after |
|
|
A
|
Grape::API.represent |
|
|
A
|
Grape:: … #initialize |
|
|
A
|
Grape:: … ::AcceptVersionHeader#before |
|
|
A
|
Grape::Exceptions::MissingVendorOption#initialize |
|
|
A
|
Grape::Middleware::Versioner::Header#before |
|
|
A
|
Grape::Middleware::Versioner::Param#before |
|
|
A
|
Grape::Middleware::Versioner::Path#before |
|
|
A
|
Grape::Middleware::Auth::OAuth2#before |
|
|
A
|
Grape::Middleware::Auth::Base#before |
|
|
A
|
Grape::Middleware::Formatter#before |
|
|
A
|
Grape::Middleware::Formatter#after |
|
|
A
|
Grape::Middleware::Globals#before |
|
|
A
|
Grape::Middleware::Filter#before |
|
|
A
|
Grape::Middleware::Filter#after |
|
| Proper documentation present | ||
|---|---|---|
|
B
|
Grape::Endpoint#error! |
|
|
B
|
Hash#deep_merge! |
|
|
B
|
Grape::API.version |
|
|
B
|
Grape::API.use |
|
|
B
|
Grape::API.scope |
|
| Show 25 more ... | ||
|
B
|
Grape::Endpoint#present |
|
|
B
|
Grape::Exceptions::Validation#as_json |
|
|
B
|
Grape::API.nest |
|
|
B
|
Grape::API.auth |
|
|
B
|
Grape::Endpoint#declared |
|
|
B
|
Grape::Endpoint#body |
|
|
B
|
Grape::Middleware::Versioner.using |
|
|
B
|
Grape::API.default_error_formatter |
|
|
B
|
Grape::Middleware::Base#initialize |
|
|
B
|
Grape::API.default_error_status |
|
|
B
|
Grape::Util::HashStack#prepend |
|
|
B
|
Grape::Util::HashStack#concat |
|
|
B
|
Grape::Endpoint#content_type |
|
|
B
|
Grape::Util::HashStack#imbue |
|
|
B
|
Grape::Namespace#initialize |
|
|
B
|
Grape::API.default_format |
|
|
B
|
Grape::API.content_type |
|
|
B
|
Grape::Endpoint#header |
|
|
B
|
Grape::API.formatter |
|
|
B
|
Grape::API.format |
|
|
B
|
Grape::API.parser |
|
|
B
|
Grape::API.prefix |
|
|
B
|
Grape::API.desc |
|
|
B
|
Grape::Middleware::Auth::Base#initialize |
|
|
B
|
Grape::Exceptions::Base#compose_message |
|
| Needs work | ||
|---|---|---|
|
C
|
Grape::API.rescue_from |
|
| Undocumented | ||
|---|---|---|
|
U
|
Grape::Exceptions::IncompatibleOptionValues#initialize |
|
|
U
|
Grape::Validations::PresenceValidator#validate_param! |
|
|
U
|
Grape::Validations::DefaultValidator#validate_param! |
|
|
U
|
Grape::Validations::CoerceValidator#validate_param! |
|
|
U
|
Grape::Validations::ClassMethods#reset_validations! |
|
| Show 262 more ... | ||
|
U
|
Grape::Validations::ValuesValidator#validate_param! |
|
|
U
|
Grape::Validations::RegexpValidator#validate_param! |
|
|
U
|
Grape::Validations::Validator#validate! |
|
|
U
|
Grape::Validations::ParamsScope#use |
|
|
U
|
Grape::Middleware::Base#call! |
|
|
U
|
Grape::Endpoint#call! |
|
|
U
|
Grape::API.namespace |
|
|
U
|
Grape::API.change! |
|
|
U
|
Grape::API.reset! |
|
|
U
|
Grape::API.call! |
|
|
U
|
Hash |
|
|
U
|
Grape::Validations::Validator#initialize |
|
|
U
|
Grape::Validations::ParamsScope#requires |
|
|
U
|
Grape::Validations::ParamsScope#optional |
|
|
U
|
Grape::Middleware::Error#exec_handler |
|
|
U
|
Grape::Validations::ParamsScope#group |
|
|
U
|
Grape::ErrorFormatter::Json.call |
|
|
U
|
Grape::ErrorFormatter::Txt.call |
|
|
U
|
Grape::ErrorFormatter::Xml.call |
|
|
U
|
Grape::Validations::MutualExclusionValidator#validate! |
|
|
U
|
Grape::Validations::ExactlyOneOfValidator#validate! |
|
|
U
|
Grape::Validations::ParamsScope#mutually_exclusive |
|
|
U
|
Grape::Validations::PresenceValidator#validate! |
|
|
U
|
Grape::Validations::ParamsScope#exactly_one_of |
|
|
U
|
Grape::Validations::DefaultValidator#validate! |
|
|
U
|
Grape::Validations::ParamsScope#initialize |
|
|
U
|
Grape::Validations::ClassMethods#params |
|
|
U
|
Grape::Middleware::Error#handle_error |
|
|
U
|
Grape::Validations::ParamsScope |
|
|
U
|
Grape::Middleware::Error#call! |
|
|
U
|
Grape::API.before_validation |
|
|
U
|
Grape::Endpoint.before_each |
|
|
U
|
Grape::Route#method_missing |
|
|
U
|
Grape::API.after_validation |
|
|
U
|
Grape::Endpoint#initialize |
|
|
U
|
Grape::API::Helpers#params |
|
|
U
|
Grape::API.http_digest |
|
|
U
|
Grape::Cookies#each |
|
|
U
|
Grape::API.options |
|
|
U
|
Grape::API.before |
|
|
U
|
Grape::API.delete |
|
|
U
|
Grape::API.patch |
|
|
U
|
Grape::API.after |
|
|
U
|
Grape::API.post |
|
|
U
|
Grape::API.head |
|
|
U
|
Grape::API.get |
|
|
U
|
Grape::API.put |
|
|
U
|
Grape:: … #initialize |
|
|
U
|
Grape::Validations::Validator::AttributesIterator#each |
|
|
U
|
Grape::Validations::SingleOptionValidator#initialize |
|
|
U
|
Grape::Middleware::Auth::OAuth2#authorization_header |
|
|
U
|
Grape::Validations::MutualExclusionValidator#params |
|
|
U
|
Grape::Validations::ClassMethods#document_attribute |
|
|
U
|
Grape::Validations::Validator.convert_to_short_name |
|
|
U
|
Grape::Validations::Validator::AttributesIterator |
|
|
U
|
Grape::Exceptions::InvalidWithOptionForRepresent |
|
|
U
|
Grape::Validations::DefaultValidator#initialize |
|
|
U
|
Grape::Middleware::Auth::OAuth2#token_parameter |
|
|
U
|
Grape::Validations::ValuesValidator#initialize |
|
|
U
|
Grape::Middleware::Auth::OAuth2#token_header |
|
|
U
|
Grape::Validations::MutualExclusionValidator |
|
|
U
|
Grape::Middleware::Auth::OAuth2#verify_token |
|
|
U
|
Grape::Middleware::Auth::OAuth2#token_class |
|
|
U
|
Grape::Middleware::Auth::Base#authenticator |
|
|
U
|
Grape::Exceptions::IncompatibleOptionValues |
|
|
U
|
Grape::Middleware::Auth::Base#base_request |
|
|
U
|
Grape::Exceptions::ValidationErrors#errors |
|
|
U
|
Grape::Middleware::Auth::Base#credentials |
|
|
U
|
Grape::Exceptions::InvalidVersionerOption |
|
|
U
|
Grape::Validations::ParamsScope#full_name |
|
|
U
|
Grape::Middleware::Auth::OAuth2#error_out |
|
|
U
|
Grape::ErrorFormatter::Base.formatter_for |
|
|
U
|
Grape::Validations::ExactlyOneOfValidator |
|
|
U
|
Grape::Exceptions::ValidationErrors#each |
|
|
U
|
Grape::Validations::ParamsScope#element= |
|
|
U
|
Grape::Middleware::Base#content_type_for |
|
|
U
|
Grape::Middleware::Error#error_response |
|
|
U
|
Grape::Validations::ParamsScope#parent= |
|
|
U
|
Grape::Middleware::Auth::OAuth2#request |
|
|
U
|
Grape::Validations::ParamsScope#element |
|
|
U
|
Grape::Middleware::Error#format_message |
|
|
U
|
Grape::Middleware::Base#default_options |
|
|
U
|
Grape::Formatter::SerializableHash.call |
|
|
U
|
Grape::ErrorFormatter::Base.formatters |
|
|
U
|
Grape::Middleware::Auth::OAuth2#params |
|
|
U
|
Grape::Middleware::Error#rack_response |
|
|
U
|
Grape::Exceptions::MissingVendorOption |
|
|
U
|
Grape::Validations::ParamsScope#parent |
|
|
U
|
Grape::Validations::ParamsScope#params |
|
|
U
|
Grape::Middleware::Base#content_types |
|
|
U
|
Grape::Middleware::Error#find_handler |
|
|
U
|
Grape::Validations::PresenceValidator |
|
|
U
|
Grape::ContentTypes.content_types_for |
|
|
U
|
Grape::Validations.register_validator |
|
|
U
|
Grape::Middleware::Base#content_type |
|
|
U
|
Grape::Middleware::Formatter#headers |
|
|
U
|
Grape::Exceptions::Validation#param= |
|
|
U
|
Grape::API.inject_api_helpers_to_mod |
|
|
U
|
Grape::Formatter::Base.formatter_for |
|
|
U
|
Grape::Validations::DefaultValidator |
|
|
U
|
Grape::Exceptions::ValidationErrors |
|
|
U
|
Grape::Exceptions::UnknownValidator |
|
|
U
|
Grape::Exceptions::Validation#param |
|
|
U
|
Grape::Validations::Validator#attrs |
|
|
U
|
Grape::Validations::ValuesValidator |
|
|
U
|
Grape::Validations::CoerceValidator |
|
|
U
|
Grape::Validations::RegexpValidator |
|
|
U
|
Grape::Exceptions::InvalidFormatter |
|
|
U
|
Grape::Exceptions::Validation#to_s |
|
|
U
|
Grape::Exceptions::Base#initialize |
|
|
U
|
Grape::Middleware::Base#mime_types |
|
|
U
|
Grape::Namespace.joined_space_path |
|
|
U
|
Grape::Formatter::SerializableHash |
|
|
U
|
Grape::Exceptions::MissingMimeType |
|
|
U
|
Grape::Formatter::Base.formatters |
|
|
U
|
Grape::Exceptions::UnknownOptions |
|
|
U
|
Grape::Middleware::Base#response |
|
|
U
|
Grape::Exceptions::MissingOption |
|
|
U
|
Grape::Exceptions::Base#headers |
|
|
U
|
Grape::Middleware::Auth::Digest |
|
|
U
|
Grape::Exceptions::Base#message |
|
|
U
|
Grape::API::Helpers#api_changed |
|
|
U
|
Grape::Middleware::Base#options |
|
|
U
|
Grape::Middleware::Auth::Basic |
|
|
U
|
Grape::Endpoint#require_option |
|
|
U
|
Grape::Validations.validators= |
|
|
U
|
Grape::Parser::Base.parser_for |
|
|
U
|
Grape::Endpoint#prepare_routes |
|
|
U
|
Grape::Exceptions::Base#status |
|
|
U
|
Grape::Middleware::Auth::Base |
|
|
U
|
Grape::Exceptions::Validation |
|
|
U
|
Grape::Namespace#requirements |
|
|
U
|
Grape::Validations.validators |
|
|
U
|
Grape::Namespace.joined_space |
|
|
U
|
Grape::Middleware::Base#call |
|
|
U
|
Grape::Endpoint#prepare_path |
|
|
U
|
Grape::Middleware::Versioner |
|
|
U
|
Grape::Util::HashStack#clone |
|
|
U
|
Grape::Endpoint#compile_path |
|
|
U
|
Grape::Path#path_with_suffix |
|
|
U
|
Grape::Middleware::Formatter |
|
|
U
|
Grape::Middleware::Base#app |
|
|
U
|
Grape::Endpoint#method_name |
|
|
U
|
Grape::ErrorFormatter::Json |
|
|
U
|
Grape::Formatter::Json.call |
|
|
U
|
Grape::Util::HashStack#to_s |
|
|
U
|
Grape::Middleware::Base#env |
|
|
U
|
Grape::ErrorFormatter::Base |
|
|
U
|
Grape::Parser::Base.parsers |
|
|
U
|
Grape::ErrorFormatter::Xml |
|
|
U
|
Grape::Util::HashStack#pop |
|
|
U
|
Grape::Middleware::Globals |
|
|
U
|
Grape::API.error_formatter |
|
|
U
|
Grape::Exceptions::Base#[] |
|
|
U
|
Grape::Formatter::Xml.call |
|
|
U
|
Grape::ErrorFormatter::Txt |
|
|
U
|
Grape::Formatter::Txt.call |
|
|
U
|
Grape::Endpoint#namespace |
|
|
U
|
Grape::Endpoint#settings= |
|
|
U
|
Grape::Endpoint#options= |
|
|
U
|
Grape::Parser::Json.call |
|
|
U
|
Grape::Endpoint#mount_in |
|
|
U
|
Grape::Middleware::Error |
|
|
U
|
Grape::Namespace#options |
|
|
U
|
Grape::Endpoint#settings |
|
|
U
|
Grape::API::Helpers#api= |
|
|
U
|
Grape::Exceptions::Base |
|
|
U
|
Grape::Endpoint#source= |
|
|
U
|
Grape::Endpoint#options |
|
|
U
|
Grape::Endpoint#request |
|
|
U
|
Grape::Route#initialize |
|
|
U
|
Grape::Parser::Xml.call |
|
|
U
|
Grape::Path#root_prefix |
|
|
U
|
Grape::API::Helpers#api |
|
|
U
|
Grape::Endpoint#headers |
|
|
U
|
Grape::Middleware::Base |
|
|
U
|
Grape::Formatter::Json |
|
|
U
|
Grape::Endpoint#params |
|
|
U
|
Grape::Formatter::Base |
|
|
U
|
Grape::Path#mount_path |
|
|
U
|
Grape::Namespace#space |
|
|
U
|
Grape::Endpoint#source |
|
|
U
|
Grape::Request#headers |
|
|
U
|
Grape::Endpoint#routes |
|
|
U
|
Grape::Endpoint#block= |
|
|
U
|
Grape::Path#initialize |
|
|
U
|
Grape::Request#params |
|
|
U
|
Grape::Formatter::Xml |
|
|
U
|
Grape::Endpoint#block |
|
|
U
|
Grape::Path#namespace |
|
|
U
|
Grape::Cookies#delete |
|
|
U
|
Grape::Formatter::Txt |
|
|
U
|
Grape::Endpoint#call |
|
|
U
|
Grape::Path#raw_path |
|
|
U
|
Grape::Cookies#write |
|
|
U
|
Grape::Path#settings |
|
|
U
|
Grape::API.route_set |
|
|
U
|
Grape::API.endpoints |
|
|
U
|
Grape::Parser::Json |
|
|
U
|
Grape::ContentTypes |
|
|
U
|
Grape::Cookies#read |
|
|
U
|
Grape::API.versions |
|
|
U
|
Grape::API.settings |
|
|
U
|
Grape::API.instance |
|
|
U
|
Grape::Parser::Base |
|
|
U
|
Grape::Endpoint#env |
|
|
U
|
Grape::Path.prepare |
|
|
U
|
Grape::Parser::Xml |
|
|
U
|
Grape::Cookies#[]= |
|
|
U
|
Grape::API.logger= |
|
|
U
|
Grape::Path#suffix |
|
|
U
|
Grape::API.compile |
|
|
U
|
Grape::Validations |
|
|
U
|
Grape::API.cascade |
|
|
U
|
Grape::API.logger |
|
|
U
|
Grape::Cookies#[] |
|
|
U
|
Grape::Route#to_s |
|
|
U
|
Grape::Namespace |
|
|
U
|
Grape::Path#to_s |
|
|
U
|
Grape::Path#path |
|
|
U
|
Grape::API.mount |
|
|
U
|
Grape::API#call |
|
|
U
|
Grape::API.call |
|
|
U
|
Grape::Cookies |
|
|
U
|
Grape::Request |
|
|
U
|
Grape::Path |
|
|
U
|
Grape::Validations::ParamsScope#push_declared_params |
|
|
U
|
Grape::Exceptions::Base#translate_attribute |
|
|
U
|
Grape::Exceptions::Base#translate_message |
|
|
U
|
Grape::API::Helpers#process_named_params |
|
|
U
|
Grape::Endpoint#before_validations |
|
|
U
|
Grape::Exceptions::Base#resolution |
|
|
U
|
Grape::Exceptions::Base#translate |
|
|
U
|
Grape::Endpoint#after_validations |
|
|
U
|
Grape::Endpoint#aggregate_setting |
|
|
U
|
Grape::Endpoint#build_middleware |
|
|
U
|
Grape::Exceptions::Base#problem |
|
|
U
|
Grape::Exceptions::Base#summary |
|
|
U
|
Grape::Endpoint#merged_setting |
|
|
U
|
Grape::API.inherit_settings |
|
|
U
|
Grape::Endpoint#run_filters |
|
|
U
|
Grape::API.prepare_routes |
|
|
U
|
Grape::Endpoint#helpers |
|
|
U
|
Grape::Endpoint#befores |
|
|
U
|
Grape::Endpoint#afters |
|
|
U
|
Grape::Endpoint#run |
|
|
U
|
Grape::Exceptions::InvalidVersionerOption#initialize |
|
|
U
|
Grape::Middleware::Versioner::Param#default_options |
|
|
U
|
Grape::Middleware::Versioner::Path#default_options |
|
|
U
|
Grape::Validations::ExactlyOneOfValidator#params |
|
|
U
|
Grape::Middleware::Auth::OAuth2#default_options |
|
|
U
|
Grape::Exceptions::ValidationErrors#initialize |
|
|
U
|
Grape::Exceptions::UnknownValidator#initialize |
|
|
U
|
Grape::Exceptions::InvalidFormatter#initialize |
|
|
U
|
Grape::Exceptions::MissingMimeType#initialize |
|
|
U
|
Grape::Middleware::Auth::Digest#base_request |
|
|
U
|
Grape::Middleware::Formatter#default_options |
|
|
U
|
Grape::Exceptions::UnknownOptions#initialize |
|
|
U
|
Grape::Middleware::Auth::Basic#base_request |
|
|
U
|
Grape::Exceptions::MissingOption#initialize |
|
|
U
|
Grape::Exceptions::Validation#initialize |
|
|
U
|
Grape::Middleware::Error#default_options |
|
Let's raise the visibility of documentation in Ruby!
This page is for intridea/grape and is part of a project called "Inch Pages", showing documentation measurements provided by Inch.
Inch Pages also provides a badge: 
(not counting low priority objects)
Can I have my own badges?
What is the goal of this?
I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.
Let's start a discussion, let's raise the visibility of documentation, let's talk.
Suggestions, feedback, critique: Hit me up on Twitter or via issue.
nch Pages