api_docs 0.0.3 → 0.0.4
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.
- data/README.md +2 -2
- data/VERSION +1 -1
- data/api_docs.gemspec +1 -1
- data/app/views/api_docs/_form.html.haml +3 -2
- data/app/views/api_docs/_panel.html.haml +1 -1
- metadata +3 -3
data/README.md
CHANGED
|
@@ -83,7 +83,7 @@ Here's a sample API for users
|
|
|
83
83
|
}
|
|
84
84
|
}
|
|
85
85
|
|
|
86
|
-
curl: curl -i :api_url/
|
|
86
|
+
curl: curl -i :api_url/users?api_key=7gR9hZt3DBqcuzi2mZKN
|
|
87
87
|
|
|
88
88
|
# ------------------------------
|
|
89
89
|
|
|
@@ -116,7 +116,7 @@ Here's a sample API for users
|
|
|
116
116
|
{
|
|
117
117
|
"message": "User not found"
|
|
118
118
|
}
|
|
119
|
-
curl: curl -i :api_url/
|
|
119
|
+
curl: curl -i :api_url/users/197?api_key=2a10K5ipBd2qapJsPvCso90kMO
|
|
120
120
|
|
|
121
121
|
# ------------------------------
|
|
122
122
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
0.0.
|
|
1
|
+
0.0.4
|
data/api_docs.gemspec
CHANGED
|
@@ -2,8 +2,9 @@
|
|
|
2
2
|
%hr/
|
|
3
3
|
%p
|
|
4
4
|
%strong Try it out:
|
|
5
|
-
|
|
6
|
-
|
|
5
|
+
- full_url = "#{ApiDocs.config.api_url}#{api_details['url']}"
|
|
6
|
+
%em #{api_details['method']} #{full_url}
|
|
7
|
+
= bootstrap_form_for '', :url => full_url, :html => {:method => api_details['method'], :target => '_blank', :class => 'form-horizontal', 'data-url' => full_url} do |f|
|
|
7
8
|
- case params
|
|
8
9
|
- when Array
|
|
9
10
|
- api_details['params'].each do |param|
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
= api_path
|
|
17
17
|
- if api_details['method']
|
|
18
18
|
%span.label.label-important= api_details['method']
|
|
19
|
-
%small #{ApiDocs.config.api_url}
|
|
19
|
+
%small #{ApiDocs.config.api_url}#{api_details['url']}
|
|
20
20
|
|
|
21
21
|
- if api_details['description']
|
|
22
22
|
%pre= api_details['description'].html_safe
|
metadata
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: api_docs
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
hash:
|
|
4
|
+
hash: 23
|
|
5
5
|
prerelease: false
|
|
6
6
|
segments:
|
|
7
7
|
- 0
|
|
8
8
|
- 0
|
|
9
|
-
-
|
|
10
|
-
version: 0.0.
|
|
9
|
+
- 4
|
|
10
|
+
version: 0.0.4
|
|
11
11
|
platform: ruby
|
|
12
12
|
authors:
|
|
13
13
|
- Jack Neto
|