rails-api-docs 0.1.0

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.

Potentially problematic release.

This version of rails-api-docs might be problematic. Click here for more details.

Files changed (24) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +142 -0
  3. data/LICENSE.txt +21 -0
  4. data/README.md +552 -0
  5. data/app/controllers/rails_api_docs/docs_controller.rb +20 -0
  6. data/config/routes.rb +5 -0
  7. data/lib/generators/rails-api-docs/init/init_generator.rb +167 -0
  8. data/lib/generators/rails-api-docs/update/update_generator.rb +28 -0
  9. data/lib/rails-api-docs/config/appender.rb +98 -0
  10. data/lib/rails-api-docs/config/builder.rb +175 -0
  11. data/lib/rails-api-docs/config/loader.rb +30 -0
  12. data/lib/rails-api-docs/configuration.rb +64 -0
  13. data/lib/rails-api-docs/engine.rb +27 -0
  14. data/lib/rails-api-docs/inspectors/body_inferrer.rb +88 -0
  15. data/lib/rails-api-docs/inspectors/controller_inspector.rb +78 -0
  16. data/lib/rails-api-docs/inspectors/json_route_detector.rb +189 -0
  17. data/lib/rails-api-docs/inspectors/route_inspector.rb +126 -0
  18. data/lib/rails-api-docs/inspectors/schema_inspector.rb +36 -0
  19. data/lib/rails-api-docs/sample_value.rb +28 -0
  20. data/lib/rails-api-docs/tasks/rails-api-docs.rake +25 -0
  21. data/lib/rails-api-docs/templates/api_docs.html.erb +695 -0
  22. data/lib/rails-api-docs/version.rb +5 -0
  23. data/lib/rails-api-docs.rb +21 -0
  24. metadata +155 -0
data/lib/rails-api-docs/version.rb ADDED
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RailsApiDocs
4
+ VERSION = "0.1.0"
5
+ end
data/lib/rails-api-docs.rb ADDED
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "rails-api-docs/version"
4
+ require_relative "rails-api-docs/configuration"
5
+ require_relative "rails-api-docs/sample_value"
6
+ require_relative "rails-api-docs/inspectors/route_inspector"
7
+ require_relative "rails-api-docs/inspectors/controller_inspector"
8
+ require_relative "rails-api-docs/inspectors/schema_inspector"
9
+ require_relative "rails-api-docs/inspectors/body_inferrer"
10
+ require_relative "rails-api-docs/inspectors/json_route_detector"
11
+ require_relative "rails-api-docs/config/builder"
12
+ require_relative "rails-api-docs/config/loader"
13
+ require_relative "rails-api-docs/config/appender"
14
+ require_relative "rails-api-docs/doc/curl_renderer"
15
+ require_relative "rails-api-docs/doc/renderer"
16
+ require_relative "rails-api-docs/doc/responder"
17
+ require_relative "rails-api-docs/doc/file_builder"
18
+ require_relative "rails-api-docs/engine" if defined?(Rails::Engine)
19
+
20
+ module RailsApiDocs
21
+ end
metadata ADDED
@@ -0,0 +1,155 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rails-api-docs
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Jackson Pires
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: railties
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - ">="
17
+ - !ruby/object:Gem::Version
18
+ version: '7.1'
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - ">="
24
+ - !ruby/object:Gem::Version
25
+ version: '7.1'
26
+ - !ruby/object:Gem::Dependency
27
+ name: prism
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: '0.24'
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - ">="
38
+ - !ruby/object:Gem::Version
39
+ version: '0.24'
40
+ - !ruby/object:Gem::Dependency
41
+ name: rails
42
+ requirement: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - ">="
45
+ - !ruby/object:Gem::Version
46
+ version: '7.1'
47
+ type: :development
48
+ prerelease: false
49
+ version_requirements: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: '7.1'
54
+ - !ruby/object:Gem::Dependency
55
+ name: minitest
56
+ requirement: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - "~>"
59
+ - !ruby/object:Gem::Version
60
+ version: '5.0'
61
+ type: :development
62
+ prerelease: false
63
+ version_requirements: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - "~>"
66
+ - !ruby/object:Gem::Version
67
+ version: '5.0'
68
+ - !ruby/object:Gem::Dependency
69
+ name: rake
70
+ requirement: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - "~>"
73
+ - !ruby/object:Gem::Version
74
+ version: '13.0'
75
+ type: :development
76
+ prerelease: false
77
+ version_requirements: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - "~>"
80
+ - !ruby/object:Gem::Version
81
+ version: '13.0'
82
+ - !ruby/object:Gem::Dependency
83
+ name: sqlite3
84
+ requirement: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '2.0'
89
+ type: :development
90
+ prerelease: false
91
+ version_requirements: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - ">="
94
+ - !ruby/object:Gem::Version
95
+ version: '2.0'
96
+ description: Inspects your Rails routes, controllers and schema to produce config/rails-api-docs.yml,
97
+ then renders a Scalar-style three-column HTML page at public/api-docs.html. Includes
98
+ a live preview mount at /rails/api-docs in development.
99
+ email:
100
+ - jackson@linkana.com
101
+ executables: []
102
+ extensions: []
103
+ extra_rdoc_files: []
104
+ files:
105
+ - CHANGELOG.md
106
+ - LICENSE.txt
107
+ - README.md
108
+ - app/controllers/rails_api_docs/docs_controller.rb
109
+ - config/routes.rb
110
+ - lib/generators/rails-api-docs/init/init_generator.rb
111
+ - lib/generators/rails-api-docs/update/update_generator.rb
112
+ - lib/rails-api-docs.rb
113
+ - lib/rails-api-docs/config/appender.rb
114
+ - lib/rails-api-docs/config/builder.rb
115
+ - lib/rails-api-docs/config/loader.rb
116
+ - lib/rails-api-docs/configuration.rb
117
+ - lib/rails-api-docs/engine.rb
118
+ - lib/rails-api-docs/inspectors/body_inferrer.rb
119
+ - lib/rails-api-docs/inspectors/controller_inspector.rb
120
+ - lib/rails-api-docs/inspectors/json_route_detector.rb
121
+ - lib/rails-api-docs/inspectors/route_inspector.rb
122
+ - lib/rails-api-docs/inspectors/schema_inspector.rb
123
+ - lib/rails-api-docs/sample_value.rb
124
+ - lib/rails-api-docs/tasks/rails-api-docs.rake
125
+ - lib/rails-api-docs/templates/api_docs.html.erb
126
+ - lib/rails-api-docs/version.rb
127
+ homepage: https://github.com/jacksonpires/rails-api-docs
128
+ licenses:
129
+ - MIT
130
+ metadata:
131
+ homepage_uri: https://github.com/jacksonpires/rails-api-docs
132
+ source_code_uri: https://github.com/jacksonpires/rails-api-docs/tree/main
133
+ changelog_uri: https://github.com/jacksonpires/rails-api-docs/blob/main/CHANGELOG.md
134
+ bug_tracker_uri: https://github.com/jacksonpires/rails-api-docs/issues
135
+ documentation_uri: https://github.com/jacksonpires/rails-api-docs#readme
136
+ rubygems_mfa_required: 'true'
137
+ rdoc_options: []
138
+ require_paths:
139
+ - lib
140
+ required_ruby_version: !ruby/object:Gem::Requirement
141
+ requirements:
142
+ - - ">="
143
+ - !ruby/object:Gem::Version
144
+ version: 3.1.0
145
+ required_rubygems_version: !ruby/object:Gem::Requirement
146
+ requirements:
147
+ - - ">="
148
+ - !ruby/object:Gem::Version
149
+ version: '0'
150
+ requirements: []
151
+ rubygems_version: 4.0.3
152
+ specification_version: 4
153
+ summary: Generate beautiful, self-contained HTML API documentation from your Rails
154
+ routes.
155
+ test_files: []