How apipie/apipie-dsl works
ApipieDSL lets Ruby DSL authors declare documentation and optionally parameter validation alongside their code. The main workflow is declaration, description/validation modeling, registry assembly, then retrieval through a Rails documentation UI or static HTML/JSON generation. README capabilities also include versioning, sections, localization, markup selection, authorization hooks, and custom help. Source excerpts establish controller-to-registry and rendering relationships; some broader capability links are documented only in the README, so unsampled internals are not inferred.
Main entry points: dsl.rb DSL declarations · apipie_dsls_controller.rb Docs controller · tasks_utils.rb Static HTML and JSON · application.rb Documentation registry
Components 16
DSL authoring
- DSL declarations
lib/apipie_dsl/dsl.rb - Configuration
lib/apipie_dsl/configuration.rb - Description models
lib/apipie_dsl/class_description.rb - Method schema
lib/apipie_dsl/method_description.rb - Parameter schema
lib/apipie_dsl/parameter_description.rb
Documentation runtime
- Parameter validation
lib/apipie_dsl/validator.rb - Markup rendering
lib/apipie_dsl/markup.rb - Documentation registry
lib/apipie_dsl/application.rb
Documentation delivery
- Docs controller
app/controllers/apipie_dsl/apipie_dsls_controller.rb - Rails routes
lib/apipie_dsl/routing.rb - Static HTML and JSON
lib/apipie_dsl/tasks_utils.rb
Presentation
- Documentation views
app/views/apipie_dsl/apipie_dsls - View helpers
app/helpers/apipie_dsl_helper.rb - Browser assets
app/public/apipie_dsl
Other components
- DSL author
- Documentation reader
Connections 17
- DSL author → DSL declarations: declares docs
README.md - DSL declarations → Description models: describes classes
- DSL declarations → Method schema: describes methods
README.md - Method schema → Parameter schema: defines parameters
README.md - Configuration → Parameter validation: configures validation
README.md - DSL declarations → Parameter validation: validates arguments
README.md - Configuration → Markup rendering: selects markup
README.md - Documentation registry → Markup rendering: formats descriptions
- Docs controller → Documentation registry: loads docs
app/controllers/apipie_dsl/apipie_dsls_controller.rb - Rails routes → Docs controller: routes requests
lib/apipie_dsl/routing.rb - Documentation reader → Rails routes: requests docs
- Docs controller → Documentation views: renders pages
app/controllers/apipie_dsl/apipie_dsls_controller.rb - Docs controller → View helpers: includes helpers
app/controllers/apipie_dsl/apipie_dsls_controller.rb - Static HTML and JSON → Documentation registry: requests doc data
lib/apipie_dsl/tasks_utils.rb - Static HTML and JSON → View helpers: includes helpers
lib/apipie_dsl/tasks_utils.rb - Documentation reader → Static HTML and JSON: views generated docs
- Documentation views → Browser assets: uses presentation assets