RubyGems - apipie-rails-jq - Versions diffs - 1.4.3.pre.beta.pre.jq.1 - Mend

apipie-rails-jq 1.4.3.pre.beta.pre.jq.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (258) hide show

checksums.yaml +7 -0
data/.github/workflows/build.yml +32 -0
data/.github/workflows/rubocop-challenger.yml +26 -0
data/.github/workflows/rubocop.yml +18 -0
data/.gitignore +16 -0
data/.rspec +2 -0
data/.rubocop.yml +132 -0
data/.rubocop_todo.yml +1967 -0
data/.vscode/settings.json +3 -0
data/APACHE-LICENSE-2.0 +202 -0
data/CHANGELOG.md +693 -0
data/Gemfile +19 -0
data/MIT-LICENSE +20 -0
data/NOTICE +4 -0
data/PROPOSAL_FOR_RESPONSE_DESCRIPTIONS.md +244 -0
data/README.md +2088 -0
data/Rakefile +8 -0
data/apipie-rails.gemspec +44 -0
data/app/controllers/apipie/apipies_controller.rb +184 -0
data/app/helpers/apipie_helper.rb +10 -0
data/app/public/apipie/javascripts/apipie.js +6 -0
data/app/public/apipie/javascripts/bundled/bootstrap-collapse.js +167 -0
data/app/public/apipie/javascripts/bundled/bootstrap.js +2280 -0
data/app/public/apipie/javascripts/bundled/jquery.js +2 -0
data/app/public/apipie/javascripts/bundled/prettify.js +28 -0
data/app/public/apipie/stylesheets/application.css +7 -0
data/app/public/apipie/stylesheets/bundled/bootstrap-responsive.min.css +9 -0
data/app/public/apipie/stylesheets/bundled/bootstrap.min.css +9 -0
data/app/public/apipie/stylesheets/bundled/prettify.css +30 -0
data/app/views/apipie/apipies/_deprecation.html.erb +16 -0
data/app/views/apipie/apipies/_disqus.html.erb +13 -0
data/app/views/apipie/apipies/_errors.html.erb +23 -0
data/app/views/apipie/apipies/_headers.html.erb +26 -0
data/app/views/apipie/apipies/_languages.erb +6 -0
data/app/views/apipie/apipies/_metadata.erb +1 -0
data/app/views/apipie/apipies/_method_detail.erb +63 -0
data/app/views/apipie/apipies/_params.html.erb +49 -0
data/app/views/apipie/apipies/_params_plain.html.erb +21 -0
data/app/views/apipie/apipies/apipie_404.html.erb +17 -0
data/app/views/apipie/apipies/apipie_checksum.json.erb +1 -0
data/app/views/apipie/apipies/getting_started.html.erb +6 -0
data/app/views/apipie/apipies/index.html.erb +56 -0
data/app/views/apipie/apipies/method.html.erb +41 -0
data/app/views/apipie/apipies/plain.html.erb +77 -0
data/app/views/apipie/apipies/resource.html.erb +80 -0
data/app/views/apipie/apipies/static.html.erb +103 -0
data/app/views/layouts/apipie/apipie.html.erb +27 -0
data/config/locales/de.yml +28 -0
data/config/locales/en.yml +41 -0
data/config/locales/es.yml +28 -0
data/config/locales/fr.yml +31 -0
data/config/locales/it.yml +41 -0
data/config/locales/ja.yml +31 -0
data/config/locales/ko.yml +32 -0
data/config/locales/pl.yml +28 -0
data/config/locales/pt-BR.yml +28 -0
data/config/locales/ru.yml +28 -0
data/config/locales/tr.yml +28 -0
data/config/locales/zh-CN.yml +28 -0
data/config/locales/zh-TW.yml +28 -0
data/gemfiles/Gemfile.tools +9 -0
data/images/screenshot-1.png +0 -0
data/images/screenshot-2.png +0 -0
data/lib/apipie/apipie_module.rb +83 -0
data/lib/apipie/application.rb +499 -0
data/lib/apipie/configuration.rb +196 -0
data/lib/apipie/core_ext/route.rb +9 -0
data/lib/apipie/dsl_definition.rb +630 -0
data/lib/apipie/error_description.rb +46 -0
data/lib/apipie/errors.rb +86 -0
data/lib/apipie/extractor/collector.rb +116 -0
data/lib/apipie/extractor/recorder.rb +193 -0
data/lib/apipie/extractor/writer.rb +454 -0
data/lib/apipie/extractor.rb +181 -0
data/lib/apipie/generator/config.rb +12 -0
data/lib/apipie/generator/generator.rb +2 -0
data/lib/apipie/generator/swagger/computed_interface_id.rb +23 -0
data/lib/apipie/generator/swagger/config.rb +80 -0
data/lib/apipie/generator/swagger/context.rb +38 -0
data/lib/apipie/generator/swagger/method_description/api_decorator.rb +20 -0
data/lib/apipie/generator/swagger/method_description/api_schema_service.rb +89 -0
data/lib/apipie/generator/swagger/method_description/decorator.rb +22 -0
data/lib/apipie/generator/swagger/method_description/parameters_service.rb +139 -0
data/lib/apipie/generator/swagger/method_description/response_schema_service.rb +46 -0
data/lib/apipie/generator/swagger/method_description/response_service.rb +71 -0
data/lib/apipie/generator/swagger/method_description.rb +2 -0
data/lib/apipie/generator/swagger/operation_id.rb +51 -0
data/lib/apipie/generator/swagger/param_description/builder.rb +114 -0
data/lib/apipie/generator/swagger/param_description/composite.rb +119 -0
data/lib/apipie/generator/swagger/param_description/description.rb +15 -0
data/lib/apipie/generator/swagger/param_description/in.rb +37 -0
data/lib/apipie/generator/swagger/param_description/name.rb +18 -0
data/lib/apipie/generator/swagger/param_description/path_params_composite.rb +61 -0
data/lib/apipie/generator/swagger/param_description/referenced_composite.rb +36 -0
data/lib/apipie/generator/swagger/param_description/type.rb +132 -0
data/lib/apipie/generator/swagger/param_description.rb +18 -0
data/lib/apipie/generator/swagger/path_decorator.rb +36 -0
data/lib/apipie/generator/swagger/referenced_definitions.rb +17 -0
data/lib/apipie/generator/swagger/resource_description_collection.rb +30 -0
data/lib/apipie/generator/swagger/resource_description_composite.rb +56 -0
data/lib/apipie/generator/swagger/schema.rb +63 -0
data/lib/apipie/generator/swagger/swagger.rb +2 -0
data/lib/apipie/generator/swagger/type.rb +16 -0
data/lib/apipie/generator/swagger/type_extractor.rb +51 -0
data/lib/apipie/generator/swagger/warning.rb +74 -0
data/lib/apipie/generator/swagger/warning_writer.rb +54 -0
data/lib/apipie/helpers.rb +73 -0
data/lib/apipie/markup.rb +52 -0
data/lib/apipie/method_description/api.rb +12 -0
data/lib/apipie/method_description/apis_service.rb +82 -0
data/lib/apipie/method_description.rb +230 -0
data/lib/apipie/middleware/checksum_in_headers.rb +35 -0
data/lib/apipie/param_description/deprecation.rb +24 -0
data/lib/apipie/param_description.rb +313 -0
data/lib/apipie/railtie.rb +9 -0
data/lib/apipie/resource_description.rb +152 -0
data/lib/apipie/response_description.rb +157 -0
data/lib/apipie/response_description_adapter.rb +202 -0
data/lib/apipie/routes_formatter.rb +33 -0
data/lib/apipie/routing.rb +16 -0
data/lib/apipie/rspec/response_validation_helper.rb +194 -0
data/lib/apipie/see_description.rb +39 -0
data/lib/apipie/static_dispatcher.rb +75 -0
data/lib/apipie/swagger_generator.rb +45 -0
data/lib/apipie/tag_list_description.rb +11 -0
data/lib/apipie/validator.rb +552 -0
data/lib/apipie/version.rb +3 -0
data/lib/apipie-rails.rb +60 -0
data/lib/generators/apipie/install/README +6 -0
data/lib/generators/apipie/install/install_generator.rb +25 -0
data/lib/generators/apipie/install/templates/initializer.rb.erb +7 -0
data/lib/generators/apipie/views_generator.rb +11 -0
data/lib/tasks/apipie.rake +355 -0
data/rel-eng/gem_release.ipynb +398 -0
data/rel-eng/packages/.readme +3 -0
data/rel-eng/packages/rubygem-apipie-rails +1 -0
data/rel-eng/tito.props +5 -0
data/spec/controllers/api/v1/architectures_controller_spec.rb +29 -0
data/spec/controllers/api/v2/architectures_controller_spec.rb +19 -0
data/spec/controllers/api/v2/empty_middle_controller_spec.rb +23 -0
data/spec/controllers/api/v2/nested/resources_controller_spec.rb +27 -0
data/spec/controllers/api/v2/sub/footguns_controller_spec.rb +19 -0
data/spec/controllers/concerns_controller_spec.rb +42 -0
data/spec/controllers/extended_controller_spec.rb +14 -0
data/spec/controllers/included_param_group_controller_spec.rb +13 -0
data/spec/controllers/pets_controller_spec.rb +98 -0
data/spec/controllers/users_controller_spec.rb +794 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/controllers/api/base_controller.rb +4 -0
data/spec/dummy/app/controllers/api/v1/architectures_controller.rb +43 -0
data/spec/dummy/app/controllers/api/v1/base_controller.rb +11 -0
data/spec/dummy/app/controllers/api/v2/architectures_controller.rb +31 -0
data/spec/dummy/app/controllers/api/v2/base_controller.rb +17 -0
data/spec/dummy/app/controllers/api/v2/empty_middle_controller.rb +14 -0
data/spec/dummy/app/controllers/api/v2/nested/architectures_controller.rb +32 -0
data/spec/dummy/app/controllers/api/v2/nested/resources_controller.rb +33 -0
data/spec/dummy/app/controllers/api/v2/sub/footguns_controller.rb +30 -0
data/spec/dummy/app/controllers/application_controller.rb +18 -0
data/spec/dummy/app/controllers/concerns_controller.rb +8 -0
data/spec/dummy/app/controllers/extended_controller.rb +14 -0
data/spec/dummy/app/controllers/extending_concern.rb +10 -0
data/spec/dummy/app/controllers/files_controller.rb +5 -0
data/spec/dummy/app/controllers/included_param_group_controller.rb +19 -0
data/spec/dummy/app/controllers/overridden_concerns_controller.rb +31 -0
data/spec/dummy/app/controllers/pets_controller.rb +408 -0
data/spec/dummy/app/controllers/pets_using_auto_views_controller.rb +73 -0
data/spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb +95 -0
data/spec/dummy/app/controllers/sample_controller.rb +39 -0
data/spec/dummy/app/controllers/tagged_cats_controller.rb +32 -0
data/spec/dummy/app/controllers/tagged_dogs_controller.rb +15 -0
data/spec/dummy/app/controllers/twitter_example_controller.rb +307 -0
data/spec/dummy/app/controllers/users_controller.rb +310 -0
data/spec/dummy/app/helpers/random_param_group.rb +8 -0
data/spec/dummy/app/views/layouts/application.html.erb +21 -0
data/spec/dummy/components/test_engine/Gemfile +6 -0
data/spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb +4 -0
data/spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb +37 -0
data/spec/dummy/components/test_engine/config/routes.rb +3 -0
data/spec/dummy/components/test_engine/db/.gitkeep +0 -0
data/spec/dummy/components/test_engine/lib/test_engine.rb +7 -0
data/spec/dummy/components/test_engine/test_engine.gemspec +11 -0
data/spec/dummy/config/application.rb +47 -0
data/spec/dummy/config/boot.rb +12 -0
data/spec/dummy/config/database.yml +21 -0
data/spec/dummy/config/environment.rb +8 -0
data/spec/dummy/config/environments/development.rb +25 -0
data/spec/dummy/config/environments/production.rb +49 -0
data/spec/dummy/config/environments/test.rb +33 -0
data/spec/dummy/config/initializers/apipie.rb +110 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +10 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +8 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +61 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/db/.gitkeep +0 -0
data/spec/dummy/doc/apipie_examples.json +1 -0
data/spec/dummy/doc/users/desc_from_file.md +1 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +26 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/public/stylesheets/.gitkeep +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/lib/apipie/apipies_controller_spec.rb +345 -0
data/spec/lib/apipie/application_spec.rb +62 -0
data/spec/lib/apipie/configuration_spec.rb +38 -0
data/spec/lib/apipie/extractor/collector_spec.rb +57 -0
data/spec/lib/apipie/extractor/recorder/middleware_spec.rb +44 -0
data/spec/lib/apipie/extractor/recorder_spec.rb +77 -0
data/spec/lib/apipie/extractor/writer_spec.rb +112 -0
data/spec/lib/apipie/extractor_spec.rb +9 -0
data/spec/lib/apipie/file_handler_spec.rb +25 -0
data/spec/lib/apipie/generator/swagger/config_spec.rb +19 -0
data/spec/lib/apipie/generator/swagger/context_spec.rb +56 -0
data/spec/lib/apipie/generator/swagger/method_description/api_schema_service_spec.rb +119 -0
data/spec/lib/apipie/generator/swagger/method_description/response_schema_service_spec.rb +105 -0
data/spec/lib/apipie/generator/swagger/method_description/response_service_spec.rb +62 -0
data/spec/lib/apipie/generator/swagger/operation_id_spec.rb +63 -0
data/spec/lib/apipie/generator/swagger/param_description/builder_spec.rb +245 -0
data/spec/lib/apipie/generator/swagger/param_description/composite_spec.rb +95 -0
data/spec/lib/apipie/generator/swagger/param_description/description_spec.rb +79 -0
data/spec/lib/apipie/generator/swagger/param_description/in_spec.rb +86 -0
data/spec/lib/apipie/generator/swagger/param_description/name_spec.rb +81 -0
data/spec/lib/apipie/generator/swagger/param_description/type_spec.rb +210 -0
data/spec/lib/apipie/generator/swagger/param_description_spec.rb +28 -0
data/spec/lib/apipie/generator/swagger/path_decorator_spec.rb +57 -0
data/spec/lib/apipie/generator/swagger/referenced_definitions_spec.rb +35 -0
data/spec/lib/apipie/generator/swagger/resource_description_composite_spec.rb +37 -0
data/spec/lib/apipie/generator/swagger/resource_descriptions_collection_spec.rb +57 -0
data/spec/lib/apipie/generator/swagger/schema_spec.rb +89 -0
data/spec/lib/apipie/generator/swagger/type_extractor_spec.rb +38 -0
data/spec/lib/apipie/generator/swagger/warning_spec.rb +51 -0
data/spec/lib/apipie/generator/swagger/warning_writer_spec.rb +71 -0
data/spec/lib/apipie/method_description/apis_service_spec.rb +60 -0
data/spec/lib/apipie/method_description_spec.rb +133 -0
data/spec/lib/apipie/no_documented_method_spec.rb +17 -0
data/spec/lib/apipie/param_description/deprecation_spec.rb +31 -0
data/spec/lib/apipie/param_description_spec.rb +671 -0
data/spec/lib/apipie/param_group_spec.rb +61 -0
data/spec/lib/apipie/resource_description_spec.rb +91 -0
data/spec/lib/apipie/response_description/response_object_spec.rb +22 -0
data/spec/lib/apipie/response_description_spec.rb +56 -0
data/spec/lib/apipie/response_does_not_match_swagger_schema_spec.rb +35 -0
data/spec/lib/apipie/swagger_generator_spec.rb +94 -0
data/spec/lib/apipie/validator_spec.rb +149 -0
data/spec/lib/rake_spec.rb +69 -0
data/spec/lib/swagger/openapi_2_0_schema.json +1614 -0
data/spec/lib/swagger/rake_swagger_spec.rb +159 -0
data/spec/lib/swagger/swagger_dsl_spec.rb +664 -0
data/spec/lib/validators/array_validator_spec.rb +85 -0
data/spec/spec_helper.rb +92 -0
data/spec/support/custom_bool_validator.rb +17 -0
data/spec/support/rake.rb +21 -0
data/spec/test_engine/memes_controller_spec.rb +10 -0
metadata +499 -0

data/app/views/layouts/apipie/apipie.html.erb ADDED Viewed

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= t('apipie.api_documentation', :default => 'Api Documentation') %></title>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <%= Apipie.include_stylesheets %>
+  <link type='text/css' rel='stylesheet' href='<%= Apipie.full_url("stylesheets/application.css")%>'/>
+  <!-- IE6-8 support of HTML5 elements -->
+  <!--[if lt IE 9]>
+    <script src="//html5shim.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+</head>
+<body>
+  <div class="container-fluid">
+    <div class="row-fluid">
+      <div id='container'>
+        <%= yield %>
+        <%= render 'disqus' if Apipie.configuration.use_disqus? %>
+      </div>
+    </div>
+    <hr>
+    <footer><%= yield :apipie_footer %></footer>
+  </div>
+  <%= Apipie.include_javascripts %>
+</body>
+</html>

data/config/locales/de.yml ADDED Viewed

@@ -0,0 +1,28 @@
+de:
+  apipie:
+    resources: Ressourcen
+    resource: Ressource
+    description: Beschreibung
+    no_docs_found: Keine Dokumentation gefunden
+    no_docs_found_descr: Es wurde keine Dokumentation für die API gefunden.
+    follow_instructions_html: Folge %{href} für eine Anleitung zur Beschreibung der Controller.
+    follow_instructions_href: weitere Anweisungen
+    oops: Upps!!
+    resource_not_found_html: Ressource %{resource} nicht gefunden.
+    method_not_found_html: Methode %{method} für %{resource} nicht gefunden.
+    goto_homepage_html: Öffne %{href}
+    goto_homepage_href: "%{app_name} API-Dokumentation"
+    required: verpflichtend
+    optional: optional
+    nil_allowed: nil erlaubt
+    param_name: Parametername
+    params: Parameter
+    examples: Beispiele
+    metadata: Metadaten
+    errors: Fehler
+    supported_formats: Unterstützte Formate
+    enable_javascript_html: Aktiviere JavaScript für den Aufruf von %{comments_href}.
+    comments_powered_by_disqus: Kommentarfunktion bereitgestellt durch %{disqus}
+    api_documentation: API-Dokumentation
+    headers: Kopfzeilen
+    header_name: Name der Kopfzeile

data/config/locales/en.yml ADDED Viewed

@@ -0,0 +1,41 @@
+en:
+  apipie:
+    resources: Resources
+    resource: Resource
+    description: Description
+    no_docs_found: No documentation found
+    no_docs_found_descr: We have not found any documentation for your API.
+    follow_instructions_html: Follow %{href} on how to describe your controllers.
+    follow_instructions_href: further instructions
+    oops: Oops!!
+    resource_not_found_html: Resource %{resource} not found.
+    method_not_found_html: Method %{method} not found for resource %{resource}.
+    goto_homepage_html: Try going to %{href}
+    goto_homepage_href: "%{app_name} API documentation homepage"
+    required: required
+    optional: optional
+    nil_allowed: nil allowed
+    blank_allowed: blank allowed
+    param_name: Param name
+    params: Params
+    examples: Examples
+    metadata: Metadata
+    errors: Errors
+    error_code: Code
+    error_description: Description
+    error_metadata: Metadata
+    supported_formats: Supported Formats
+    enable_javascript_html: Please enable JavaScript to view the %{comments_href}.
+    comments_powered_by_disqus: comments powered by %{disqus}
+    api_documentation: API documentation
+    headers: Headers
+    header_name: Header name
+    code: Code
+    returns: Returns
+    deprecated: Deprecated
+    deprecation_details: Deprecation details
+    deprecation:
+      attributes:
+        deprecated_in: Deprecated in
+        sunset_at: Sunset at
+        info: Info

data/config/locales/es.yml ADDED Viewed

@@ -0,0 +1,28 @@
+es:
+  apipie:
+    resources: Recursos
+    resource: Recurso
+    description: Descripción
+    no_docs_found: No se encontró la documentación
+    no_docs_found_descr: No hemos encontrado ninguna documentación para tu API.
+    follow_instructions_html: Siga %{href} sobre cómo describir sus controladores.
+    follow_instructions_href: más instrucciones
+    oops: Huy!!
+    resource_not_found_html: Recurso %{resource} no encontrado.
+    method_not_found_html: Método  %{method} no encontrado para el recurso %{resource}.
+    goto_homepage_html: Trate de ir a %{href}
+    goto_homepage_href: "%{app_name} página de documentación API  "
+    required: requerido
+    optional: opcional
+    nil_allowed: nil permitido
+    param_name: Nombre del parámetro
+    params: Parámetros
+    examples: Ejemplos
+    metadata: Metadatos
+    errors: Errores
+    supported_formats: Formatos soportados
+    enable_javascript_html: Por favor, active JavaScript para ver el %{comments_href}.
+    comments_powered_by_disqus: comentarios gracias a %{disqus}
+    api_documentation: Documentación de la API
+    headers: Cabeceras
+    header_name: Nombre de cabecera

data/config/locales/fr.yml ADDED Viewed

@@ -0,0 +1,31 @@
+fr:
+  apipie:
+    resources: Ressources
+    resource: Ressource
+    description: Description
+    no_docs_found: Aucune documentation trouvée
+    no_docs_found_descr: Aucune documentation pour cette API
+    follow_instructions_html: Suivez ces %{href} sur la façon dont décrire vos controlleurs.
+    follow_instructions_href: instructions supplémentaires
+    oops: Oops!!
+    resource_not_found_html: Ressource %{resource} not found.
+    method_not_found_html: Méthode %{method} non trouvée pour la ressource %{resource}.
+    goto_homepage_html: Essayez de regarder %{href}
+    goto_homepage_href: "la page d'accueil %{app_name} API documentation homepage"
+    required: requis
+    optional: optionel
+    nil_allowed: nil autorisé
+    param_name: Nom du paramètre
+    params: Paramètres
+    examples: Exemples
+    metadata: Metadata
+    errors: Erreurs
+    error_code: Code
+    error_description: Description
+    error_metadata: Metadata
+    supported_formats: Formats supportés
+    enable_javascript_html: Activez JavaScript SVP pour afficher la %{comments_href}.
+    comments_powered_by_disqus: section commentaires par %{disqus}
+    api_documentation: documentation API
+    headers: Headers
+    header_name: Nom du header

data/config/locales/it.yml ADDED Viewed

@@ -0,0 +1,41 @@
+it:
+  apipie:
+    resources: Risorse
+    resource: Risorsa
+    description: Descrizione
+    no_docs_found: Nessuna documentazione trovata
+    no_docs_found_descr: Non abbiamo trovato nessuna documentazione per la tua API.
+    follow_instructions_html: Leggi su %{href} come descrivere i tuoi controller.
+    follow_instructions_href: ulteriori istruzioni
+    oops: Ops!!
+    resource_not_found_html: Risorsa %{resource} non trovata.
+    method_not_found_html: Metodo %{method} non trovato per la risorsa %{resource}.
+    goto_homepage_html: Prova ad andare su %{href}
+    goto_homepage_href: "%{app_name} Homepage della documentazione API"
+    required: richiesto
+    optional: opzionale
+    nil_allowed: consentito nil
+    blank_allowed: consentito vuoto
+    param_name: Nome parametro
+    params: Parametri
+    examples: Esempi
+    metadata: Metadata
+    errors: Errori
+    error_code: Codice
+    error_description: Descrizione
+    error_metadata: Metadata
+    supported_formats: Formati supportati
+    enable_javascript_html: Abilita i JavaScript per vedere %{comments_href}.
+    comments_powered_by_disqus: commenti forniti da %{disqus}
+    api_documentation: Documentazione API
+    headers: Header
+    header_name: Nome Header
+    code: Codice
+    returns: Ritorno
+    deprecated: Deprecato
+    deprecation_details: Dettagli di deprecazione
+    deprecation:
+      attributes:
+        deprecated_in: Deprecato il
+        sunset_at: Rimozione il
+        info: Informazioni

data/config/locales/ja.yml ADDED Viewed

@@ -0,0 +1,31 @@
+ja:
+  apipie:
+    resources: "リソース"
+    resource: "リソース"
+    description: "記述"
+    no_docs_found: "ドキュメントが見つかりませんでした。"
+    no_docs_found_descr: "あなたのAPIにあう資料が見つかりませんでした。"
+    follow_instructions_html: "コントローラーをどう説明するのか%{href}を参考にしてください。"
+    follow_instructions_href: "具体的な説明"
+    oops: "おっと！"
+    resource_not_found_html: "リソース%{resource}が見つかりませんでした。"
+    method_not_found_html: "リソース%{resource}のためのメソッド%{method}が見つかりませんでした。 ."
+    goto_homepage_html: "%{href}へ移ります。"
+    goto_homepage_href: "%{app_name}APIドキュメントのホームページ"
+    required: "必須"
+    optional: "任意"
+    nil_allowed: "nil可"
+    param_name: "パラメーター名"
+    params: "パラメーター"
+    examples: "例"
+    metadata: "メタデータ"
+    errors: "エラー"
+    error_code: "エラーコード"
+    error_description: "エラー説明"
+    error_metadata: "エラーメタデータ"
+    supported_formats: "サポートフォーマット"
+    enable_javascript_html: "%{comments_href}のJavaScriptをオンにしてください。"
+    comments_powered_by_disqus: "%{disqus}によるコメント"
+    api_documentation: "APIドキュメント"
+    headers: "ヘッダー"
+    header_name: "ヘッダー名"

data/config/locales/ko.yml ADDED Viewed

@@ -0,0 +1,32 @@
+ko:
+  apipie:
+    resources: 리소스
+    resource: 리소스
+    description: 설명
+    no_docs_found: 문서를 찾을 수 없습니다.
+    no_docs_found_descr: 해당 API에 대한 문서를 찾을 수 없습니다.
+    follow_instructions_html: 해당 컨트롤러의 설명을 %{href}를 따르세요.
+    follow_instructions_href: 자세한 설명
+    oops: 이런!!
+    resource_not_found_html: "%{resource} 리소스를 찾을 수 없습니다."
+    method_not_found_html: "%{resource} 리소스에 대한 %{method} 메소드를 찾을 수 없습니다."
+    goto_homepage_html: "%{href}로 시도해보세요."
+    goto_homepage_href: "%{app_name} API 문서 페이지"
+    required: 필수
+    optional: 옵션
+    nil_allowed: nil 허용
+    blank_allowed: blank 허용
+    param_name: Param 이름
+    params: Params
+    examples: 예시
+    metadata: Metadata
+    errors: 에러
+    error_code: 코드
+    error_description: 설명
+    error_metadata: Metadata
+    supported_formats: 지원 포멧
+    enable_javascript_html: "%{comments_href}를 보기 위해서 JavaScript를 허용해주세요."
+    comments_powered_by_disqus: comments powered by %{disqus}
+    api_documentation: API 문서
+    headers: 헤더
+    header_name: 헤더 이름

data/config/locales/pl.yml ADDED Viewed

@@ -0,0 +1,28 @@
+pl:
+  apipie:
+    resources: Zasoby
+    resource: Zasób
+    description: Opis
+    no_docs_found: Nie znalezionio dokumentacji
+    no_docs_found_descr: Nie znaleziono dokumentacji dla twojego API.
+    follow_instructions_html: Przejdź do %{href} aby opisać swoje kontrolery.
+    follow_instructions_href: dalsze instrukcje
+    oops: Ups!!
+    resource_not_found_html: Zasób %{resource} nie został znaleziony.
+    method_not_found_html: Metoda %{method} dla zasobu %{resource} nie została znaleziona.
+    goto_homepage_html: Spróbuj przejść do %{href}
+    goto_homepage_href: "%{app_name} Strona główna dokumentacji API"
+    required: wymagany
+    optional: opcjonalny
+    nil_allowed: nil dopuszczalny
+    param_name: Nazwa parametru
+    params: Parametry
+    examples: Przykłady
+    metadata: Metadane
+    errors: Błędy
+    supported_formats: Dostępne formaty
+    enable_javascript_html: Proszę włączyć obsługę JavaScript w celu zobaczenia %{comments_href}.
+    comments_powered_by_disqus: komentarze obsługiwane przez %{disqus}
+    api_documentation: Dokumentacja API
+    headers: Nagłówki
+    header_name: Nazwa nagłówka

data/config/locales/pt-BR.yml ADDED Viewed

@@ -0,0 +1,28 @@
+'pt-BR':
+  apipie:
+    resources: Recursos
+    resource: Recurso
+    description: Descrição
+    no_docs_found: Documentação não encontrada
+    no_docs_found_descr: Não encontramos nenhuma documentação para sua API.
+    follow_instructions_html: Siga %{href} para saber como descrever seus controllers.
+    follow_instructions_href: mais instruções
+    oops: Oops!!
+    resource_not_found_html: Recurso %{resource} não encontrado.
+    method_not_found_html: Método %{method} não encontrado para o recurso %{resource}.
+    goto_homepage_html: Tente ir para %{href}
+    goto_homepage_href: "%{app_name} API - Página inicial da documentação"
+    required: requerido
+    optional: opcional
+    nil_allowed: nulo permitido
+    param_name: Nome parâmetro
+    params: Parâmetros
+    examples: Exemplos
+    metadata: Metadado
+    errors: Erros
+    supported_formats: Formatos Suportados
+    enable_javascript_html: Por favor, habilite JavaScript para ver %{comments_href}.
+    comments_powered_by_disqus: comentário feito por %{disqus}
+    api_documentation: Documentação da API
+    headers: Cabeçalhos
+    header_name: Nome cabeçalho

data/config/locales/ru.yml ADDED Viewed

@@ -0,0 +1,28 @@
+ru:
+  apipie:
+    resources: Ресурсы
+    resource: Ресурс
+    description: Описание
+    no_docs_found: Документация не найдена
+    no_docs_found_descr: Мы не нашли никакой документации для вашего API.
+    follow_instructions_html: Перейдите по ссылке %{href}, чтобы узнать как описать ваш API.
+    follow_instructions_href: дополнительные инструкции
+    oops: Ой!!
+    resource_not_found_html: Ресурс %{resource} не найден.
+    method_not_found_html: Метод %{method} для ресурса %{resource} не найден.
+    goto_homepage_html: Перейдите %{href}
+    goto_homepage_href: "%{app_name} домашняя страница API документации"
+    required: обязательно
+    optional: необязательно
+    nil_allowed: nil разрешен
+    param_name: Имя параметра
+    params: Параметры
+    examples: Примеры
+    metadata: Метаданные
+    errors: Ошибки
+    supported_formats: Поддерживаемые форматы
+    enable_javascript_html: Пожалуйста включите JavaScript, чтобы просматривать %{comments_href}.
+    comments_powered_by_disqus: комментарии представлены %{disqus}
+    api_documentation: API документация
+    headers: Заголовки
+    header_name: Название заголовка

data/config/locales/tr.yml ADDED Viewed

@@ -0,0 +1,28 @@
+tr:
+  apipie:
+    resources: Kaynaklar
+    resource: Kaynak
+    description: Açıklama
+    no_docs_found: Hiçbir belge bulunamadı
+    no_docs_found_descr: API'niz için hiçbir belge bulunamadı.
+    follow_instructions_html: Controller açıklaması belgeleri için %{href} yolunu izleyin.
+    follow_instructions_href: daha fazla talimatlar
+    oops: Üzgünüz!!
+    resource_not_found_html: Kaynak %{resource} bulunamadı.
+    method_not_found_html: "%{resource} kaynağının %{method} yöntemi bulunamadı."
+    goto_homepage_html: "%{href} adresini deneyin"
+    goto_homepage_href: "%{app_name} API belgeleri ana sayfası"
+    required: gerekli
+    optional: isteğe bağlı
+    nil_allowed: nil olabilir
+    param_name: Parametre adı
+    params: Parametreler
+    examples: Örnekler
+    metadata: Üst veriler
+    errors: Hatalar
+    supported_formats: Desteklenen Biçimler
+    enable_javascript_html: "%{comments_href} adresini görebilmek için lütfen JavaScript'i etkinleştirin."
+    comments_powered_by_disqus: yorumlar %{disqus} tarafından desteklenmektedir
+    api_documentation: API belgeleri
+    headers: Üst bilgiler
+    header_name: Üst bilgi adı

data/config/locales/zh-CN.yml ADDED Viewed

@@ -0,0 +1,28 @@
+'zh-CN':
+  apipie:
+    resources: 资源
+    resource: 资源
+    description: 描述
+    no_docs_found: 没有找到文档
+    no_docs_found_descr: 没有找到文档。
+    follow_instructions_html: 点击 %{href} 查看描述。
+    follow_instructions_href: 高级指导
+    oops: Oops!!
+    resource_not_found_html: 没有找到资源 %{resource} 。
+    method_not_found_html: 没有找到资源 %{resource} 的方法 %{method} 。
+    goto_homepage_html: 试图访问 %{href}
+    goto_homepage_href: "%{app_name} API 文档主页"
+    required: 必填
+    optional: 选填
+    nil_allowed: 允许空值
+    param_name: 参数名字
+    params: 参数
+    examples: 示例
+    metadata: 元数据
+    errors: 错误
+    supported_formats: 支持格式
+    enable_javascript_html: 浏览 %{comments_href}前请允许执行 JavaScript 。
+    comments_powered_by_disqus: 评论技术支持 %{disqus}
+    api_documentation: API 文档
+    headers: 头部
+    header_name: 头部名字

data/config/locales/zh-TW.yml ADDED Viewed

@@ -0,0 +1,28 @@
+'zh-TW':
+  apipie:
+    resources: 資源
+    resource: 資源
+    description: 描述
+    no_docs_found: 沒有找到文檔
+    no_docs_found_descr: 沒有找到文檔。
+    follow_instructions_html: 點擊 %{href} 查看描述。
+    follow_instructions_href: 高級指導
+    oops: Oops!!
+    resource_not_found_html: 沒有找到資源 %{resource} 。
+    method_not_found_html: 沒有找到資源 %{resource} 的方法 %{method} 。
+    goto_homepage_html: 試圖訪問 %{href}
+    goto_homepage_href: "%{app_name} API 文檔主頁"
+    required: 必填
+    optional: 選填
+    nil_allowed: 允許空值
+    param_name: 參數名字
+    params: 參數
+    examples: 示例
+    metadata: 元數據
+    errors: 錯誤
+    supported_formats: 支持格式
+    enable_javascript_html: 瀏覽 %{comments_href}前請允許執行 JavaScript 。
+    comments_powered_by_disqus: 評論技術支持 %{disqus}
+    api_documentation: API 文檔
+    headers: 頭部
+    header_name: 頭部名字

data/gemfiles/Gemfile.tools ADDED Viewed

@@ -0,0 +1,9 @@
+# This Gemfile is used for IDEs like VS Code that need specific gems installed
+# for their tools to work properly. It is not used for the application itself.
+source 'https://rubygems.org'
+gem 'rubocop-rails'
+gem 'rubocop-rspec'
+gem 'rubocop-performance'
+gem 'ruby-lsp', '~> 0.5.1'

data/images/screenshot-1.png ADDED Viewed

Binary file

data/images/screenshot-2.png ADDED Viewed

Binary file

data/lib/apipie/apipie_module.rb ADDED Viewed

@@ -0,0 +1,83 @@
+require "apipie/helpers"
+require "apipie/application"
+module Apipie
+  extend Apipie::Helpers
+  def self.app
+    @application ||= Apipie::Application.new
+  end
+  def self.to_json(version = nil, resource_id = nil, method_name = nil, lang = nil)
+    version ||= Apipie.configuration.default_version
+    app.to_json(version, resource_id, method_name, lang)
+  end
+  def self.to_swagger_json(version = nil, resource_id = nil, method_name = nil, lang = nil, clear_warnings = true)
+    version ||= Apipie.configuration.default_version
+    app.to_swagger_json(version, resource_id, method_name, lang, clear_warnings)
+  end
+  def self.json_schema_for_method_response(controller_name, method_name, return_code, allow_nulls)
+    # note: this does not support versions (only the default version is queried)!
+    version ||= Apipie.configuration.default_version
+    app.json_schema_for_method_response(version, controller_name, method_name, return_code, allow_nulls)
+  end
+  def self.json_schema_for_self_describing_class(cls, allow_nulls = true)
+    app.json_schema_for_self_describing_class(cls, allow_nulls)
+  end
+  # all calls delegated to Apipie::Application instance
+  def self.method_missing(method, *args, &block)
+    app.respond_to?(method) ? app.send(method, *args, &block) : super
+  end
+  def self.configure
+    yield configuration
+  end
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  def self.debug(message)
+    puts message if Apipie.configuration.debug
+  end
+  # get application description for given or default version
+  def self.app_info(version = nil, lang = nil)
+    info = if app_info_version_valid? version
+      translate(self.configuration.app_info[version], lang)
+    elsif app_info_version_valid? Apipie.configuration.default_version
+      translate(self.configuration.app_info[Apipie.configuration.default_version], lang)
+    else
+      "Another API description"
+    end
+    Apipie.markup_to_html info
+  end
+  def self.api_base_url(version = nil)
+    if api_base_url_version_valid? version
+      self.configuration.api_base_url[version]
+    elsif api_base_url_version_valid? Apipie.configuration.default_version
+      self.configuration.api_base_url[Apipie.configuration.default_version]
+    else
+      "/api"
+    end
+  end
+  def self.app_info_version_valid?(version)
+    version && self.configuration.app_info.key?(version)
+  end
+  def self.api_base_url_version_valid?(version)
+    version && self.configuration.api_base_url.key?(version)
+  end
+  def self.record(record)
+    Apipie::Extractor.start record
+  end
+end