autodoc 0.0.1 → 0.0.2
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.
- checksums.yaml +4 -4
- data/README.md +5 -4
- data/lib/autodoc/document.rb +1 -1
- data/lib/autodoc/version.rb +1 -1
- data/spec/dummy/doc/recipes.md +2 -3
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9f28352ff24e3c6fdf3a216edefe9bab4ea47ab7
|
|
4
|
+
data.tar.gz: ac44963e5b1ade2bad547e9ac9d8cc50beb84a30
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9e9f5fa9018542f1077182d0915f0e68ad25bcf952d6a32e517d5b355ff385e75a287596e700483703eaf55117e81002eb9fb30db64babe2200cb5ef5bbae1eb
|
|
7
|
+
data.tar.gz: 467e4ae8db8f3facfb2bfae62e16dc3336d6e09c5abd5c47d8339bcfe0b7095f2d46c2bd80a366e8d65b36e68125ea41e9f5d957ff10ff8df5bc08ebd003289d
|
data/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Autodoc
|
|
2
|
-
Auto-generate API documents from your request-specs.
|
|
2
|
+
Auto-generate JSON API documents from your request-specs.
|
|
3
3
|
|
|
4
4
|
## Installation
|
|
5
5
|
```ruby
|
|
@@ -23,7 +23,8 @@ describe "Recipes" do
|
|
|
23
23
|
|
|
24
24
|
describe "POST /recipes", autodoc: true do
|
|
25
25
|
it "creates a new recipe" do
|
|
26
|
-
post "/recipes", params
|
|
26
|
+
post "/recipes.json", params
|
|
27
|
+
response.status.should == 201
|
|
27
28
|
end
|
|
28
29
|
end
|
|
29
30
|
end
|
|
@@ -43,7 +44,6 @@ POST /recipes
|
|
|
43
44
|
* `name` string (required)
|
|
44
45
|
* `type` integer
|
|
45
46
|
|
|
46
|
-
|
|
47
47
|
### response
|
|
48
48
|
```
|
|
49
49
|
Status: 201
|
|
@@ -52,7 +52,8 @@ response:
|
|
|
52
52
|
{
|
|
53
53
|
"created_at" => "2013-06-07T08:28:35Z",
|
|
54
54
|
"id" => 1,
|
|
55
|
-
"name" => "
|
|
55
|
+
"name" => "alice",
|
|
56
|
+
"type" => 1,
|
|
56
57
|
"updated_at" => "2013-06-07T08:28:35Z"
|
|
57
58
|
}
|
|
58
59
|
```
|
data/lib/autodoc/document.rb
CHANGED
data/lib/autodoc/version.rb
CHANGED
data/spec/dummy/doc/recipes.md
CHANGED
|
@@ -9,17 +9,16 @@ POST /recipes
|
|
|
9
9
|
* `name` string (required)
|
|
10
10
|
* `type` integer
|
|
11
11
|
|
|
12
|
-
|
|
13
12
|
### response
|
|
14
13
|
```
|
|
15
14
|
Status: 201
|
|
16
15
|
location: http://www.example.com/recipes/1
|
|
17
16
|
response:
|
|
18
17
|
{
|
|
19
|
-
"created_at" => "2013-06-07T08:
|
|
18
|
+
"created_at" => "2013-06-07T08:58:12Z",
|
|
20
19
|
"id" => 1,
|
|
21
20
|
"name" => "name",
|
|
22
|
-
"updated_at" => "2013-06-07T08:
|
|
21
|
+
"updated_at" => "2013-06-07T08:58:12Z"
|
|
23
22
|
}
|
|
24
23
|
```
|
|
25
24
|
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: autodoc
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ryo Nakamura
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2013-06-
|
|
11
|
+
date: 2013-06-10 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: awesome_print
|