oas_core 0.0.1 β†’ 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.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -37
  3. data/lib/oas_core/version.rb +1 -1
  4. metadata +3 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3f0fe9c1e805e658bef1a7f547438bbde3433d48a29166c2cdd9c8072788ce09
4
- data.tar.gz: 3d0b42e3da71913efc5ef6cd4a4ec959741dfbe511494a41376205600626e583
3
+ metadata.gz: 9f1ed49861556546b0712b0bf9db58ba28ac53f70e5de3d2276ef45d706b0e34
4
+ data.tar.gz: dd3a8d125eb474036e48dc78722cf82ec3341760f903edf2ab4908eb011d6025
5
5
  SHA512:
6
- metadata.gz: f6d05861cc537f02d7839189cdbef925e3b6211d07379165ad0a681dd98a4c91e838e93d66eec28281935c6f87c1cec8b0af19af3112c2443855e2c5de7b7acf
7
- data.tar.gz: 1771cc1d85c3dcaf6b45af50f9c12dd5c8bcb7bd0b8d682f259cd6ba4fd442b85ba069628501902e22d16b48cdf54a4057b239fda8047adbc12163d91b464017
6
+ metadata.gz: ee76879d24af4ffe84279586567edbffd20328aa3d742fc36be9f25a79e218fd0496c87b497a939a534f555dd1c0b285ad7e21e8f8058cd49a8df6f20763dd1f
7
+ data.tar.gz: ee8f32f1ab91af11aa5ccc56f60d63e32fa50d4e55a3211a7955ef3183df028533bc520038f23c889322742eb79d0de1db6ba7e5f3486d4802abd84a3a0d969b
data/README.md CHANGED
@@ -7,43 +7,7 @@
7
7
 
8
8
  # πŸ“ƒOpen API Specification For Rails
9
9
 
10
- OasCore is a Rails engine for generating **automatic interactive documentation for your Rails APIs**. It generates an **OAS 3.1** document and displays it using **[RapiDoc](https://rapidocweb.com)**.
11
-
12
- ### πŸš€ Demo App
13
-
14
- Explore the interactive documentation live:
15
-
16
- πŸ”— **[Open Demo App](https://paso.fly.dev/api/docs)**
17
- πŸ‘€ **Username**: `oasrails`
18
- πŸ”‘ **Password**: `oasrails`
19
-
20
- 🎬 A Demo Installation/Usage Video:
21
- <https://vimeo.com/1013687332>
22
- 🎬
23
-
24
- ![Screenshot](https://a-chacon.com/assets/images/oas_core_ui.png)
25
-
26
- ## Related Projects
27
-
28
- - **[ApiPie](https://github.com/Apipie/apipie-rails)**: Doesn't support OAS 3.1, requires learning a DSL, lacks a nice UI
29
- - **[swagger_yard-rails](https://github.com/livingsocial/swagger_yard-rails)**: Seems abandoned, but serves as inspiration
30
- - **[Rswag](https://github.com/rswag/rswag)**: Not automatic, depends on RSpec; Many developers now use Minitest as it's the default test framework
31
- - **[grape-swagger](https://github.com/ruby-grape/grape-swagger)**: Requires Grape
32
- - **[rspec_api_documentation](https://github.com/zipmark/rspec_api_documentation)**: Requires RSpec and a command to generate the docs
33
-
34
- ## What Sets OasCore Apart?
35
-
36
- - **Dynamic**: No command required to generate docs
37
- - **Simple**: Complement default documentation with a few comments; no need to learn a complex DSL
38
- - **Pure Ruby on Rails APIs**: No additional frameworks needed (e.g., Grape, RSpec)
39
-
40
- ## πŸ“½οΈ Motivation
41
-
42
- After experiencing the interactive documentation in Python's fast-api framework, I sought similar functionality in Ruby on Rails. Unable to find a suitable solution, I [asked on Stack Overflow](https://stackoverflow.com/questions/71947018/is-there-a-way-to-generate-an-interactive-documentation-for-rails-apis) years ago. Now, with some free time while freelancing as an API developer, I decided to build my own tool.
43
-
44
- **Note: This is not yet a production-ready solution. The code may be rough and behave unexpectedly, but I am actively working on improving it. If you like the idea, please consider contributing to its development.**
45
-
46
- The goal is to minimize the effort required to create comprehensive documentation. By following REST principles in Rails, we believe this is achievable. You can enhance the documentation using [Yard](https://yardoc.org/) tags.
10
+ Generates OpenAPI Specification (OAS) documents by analyzing and extracting routes from Rails applications.
47
11
 
48
12
  ## Documentation
49
13
 
data/lib/oas_core/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module OasCore
4
- VERSION = '0.0.1'
4
+ VERSION = '0.1.0'
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: oas_core
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - a-chacon
@@ -38,11 +38,8 @@ dependencies:
38
38
  - !ruby/object:Gem::Version
39
39
  version: '0.9'
40
40
  description: OasCore simplifies API documentation by automatically generating OpenAPI
41
- Specification (OAS 3.1) documents from your Rails application routes. It eliminates
42
- the need for manual documentation, ensuring accuracy and consistency. The gem integrates
43
- seamlessly with Rails, providing a hassle-free way to create interactive API documentation.
44
- Ideal for developers and teams aiming to maintain up-to-date API specs with minimal
45
- effort.
41
+ Specification (OAS 3.1) documents from your Ruby application routes. It eliminates
42
+ the need for manual documentation, ensuring accuracy and consistency.
46
43
  email:
47
44
  - andres.ch@protonmail.com
48
45
  executables: []