You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ This application uses the next gems:
14
14
Apipie-rails is a DSL and Rails engine for documenting your RESTful API. Instead of traditional use of `#comments`, Apipie lets you describe the code, through the code.
15
15
16
16
### Getting started
17
-
Add gem to your Gemfile
17
+
Add the gem to your Gemfile
18
18
```ruby
19
19
# Gemfile
20
20
gem 'apipie-rails'
@@ -73,7 +73,7 @@ def create
73
73
end
74
74
end
75
75
```
76
-
Thats all! Follow the link [localhost:3000/apipie](http://localhost:3000/apipie) to check the generated API documentation.
76
+
That's all! Follow the link [localhost:3000/apipie](http://localhost:3000/apipie) to check the generated API documentation.
@@ -84,7 +84,7 @@ Thats all! Follow the link [localhost:3000/apipie](http://localhost:3000/apipie)
84
84
For more information please check out [apipie gem documentation]([https://github.com/Apipie/apipie-rails#documentation)
85
85
86
86
## DOX
87
-
Dox generates API documentation from Rspec controller/request specs in a Rails application. It formats the output of the tests in the [API Blueprint](https://apiblueprint.org/) format.
87
+
Dox generates API documentation from RSpec controller/request specs in a Rails application. It formats the output of the tests in the [API Blueprint](https://apiblueprint.org/) format.
88
88
89
89
### Getting started
90
90
Add this line into your Gemfile:
@@ -95,7 +95,7 @@ end
95
95
```
96
96
Run `bundle install`
97
97
98
-
Require Dox in the `rails_helper` and configure rspec:
98
+
Require Dox in the `rails_helper` and configure RSpec:
99
99
```ruby
100
100
# spec/rails_helper.rb
101
101
@@ -218,7 +218,7 @@ namespace :api do
218
218
end
219
219
end
220
220
```
221
-
Now the documentation can be generated by `rake api:doc:generate` command
221
+
Now the documentation can be generated by `rake api:doc:generate` command.
222
222
223
223
### Renderers
224
224
You can render the HTML by yourself with one of the renderers:
@@ -230,7 +230,7 @@ Both of them support multiple themes and template customization.
230
230
Or you can just take your generated markdown and host your documentation on [Apiary.io](https://apiary.io/)
231
231
232
232
#### Apiary
233
-
To use apiary you need to install [apiary gem](https://github.com/apiaryio/apiary-client)
233
+
To use apiary, you need to install [apiary gem](https://github.com/apiaryio/apiary-client)
234
234
```ruby
235
235
# Gemfile
236
236
@@ -263,7 +263,7 @@ namespace :api do
263
263
end
264
264
```
265
265
266
-
Now you have a well-formatted documentation generated out of the specs to share with your team:
266
+
Now you have well-formatted documentation generated out of the specs to share with your team:
Gem [rspec_api_documentation](https://github.com/zipmark/rspec_api_documentation) generates API documentation from RSpec like the [dox gem](https://github.com/infinum/dox).
282
282
@@ -330,7 +330,7 @@ rake docs:generate
330
330
```
331
331
Now you can find your documentation here `doc/api/index.html`.
0 commit comments