swagger_rails 1.0.0.pre.beta
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/MIT-LICENSE +20 -0
- data/README.rdoc +3 -0
- data/Rakefile +24 -0
- data/app/controllers/swagger_rails/application_controller.rb +8 -0
- data/app/controllers/swagger_rails/swagger_ui_controller.rb +14 -0
- data/app/helpers/swagger_rails/application_helper.rb +4 -0
- data/app/views/swagger_rails/swagger_ui/index.html.erb +145 -0
- data/bower_components/swagger-ui/dist/css/print.css +1172 -0
- data/bower_components/swagger-ui/dist/css/reset.css +125 -0
- data/bower_components/swagger-ui/dist/css/screen.css +1279 -0
- data/bower_components/swagger-ui/dist/css/style.css +250 -0
- data/bower_components/swagger-ui/dist/css/typography.css +26 -0
- data/bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-700.eot +0 -0
- data/bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-700.svg +411 -0
- data/bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-700.ttf +0 -0
- data/bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-700.woff +0 -0
- data/bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-700.woff2 +0 -0
- data/bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-regular.eot +0 -0
- data/bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-regular.svg +403 -0
- data/bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-regular.ttf +0 -0
- data/bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-regular.woff +0 -0
- data/bower_components/swagger-ui/dist/fonts/droid-sans-v6-latin-regular.woff2 +0 -0
- data/bower_components/swagger-ui/dist/images/explorer_icons.png +0 -0
- data/bower_components/swagger-ui/dist/images/favicon-16x16.png +0 -0
- data/bower_components/swagger-ui/dist/images/favicon-32x32.png +0 -0
- data/bower_components/swagger-ui/dist/images/favicon.ico +0 -0
- data/bower_components/swagger-ui/dist/images/logo_small.png +0 -0
- data/bower_components/swagger-ui/dist/images/pet_store_api.png +0 -0
- data/bower_components/swagger-ui/dist/images/throbber.gif +0 -0
- data/bower_components/swagger-ui/dist/images/wordnik_api.png +0 -0
- data/bower_components/swagger-ui/dist/index.html +119 -0
- data/bower_components/swagger-ui/dist/lang/en.js +53 -0
- data/bower_components/swagger-ui/dist/lang/es.js +52 -0
- data/bower_components/swagger-ui/dist/lang/pt.js +53 -0
- data/bower_components/swagger-ui/dist/lang/ru.js +52 -0
- data/bower_components/swagger-ui/dist/lang/translator.js +39 -0
- data/bower_components/swagger-ui/dist/lib/backbone-min.js +15 -0
- data/bower_components/swagger-ui/dist/lib/handlebars-2.0.0.js +28 -0
- data/bower_components/swagger-ui/dist/lib/highlight.7.3.pack.js +1 -0
- data/bower_components/swagger-ui/dist/lib/jquery-1.8.0.min.js +2 -0
- data/bower_components/swagger-ui/dist/lib/jquery.ba-bbq.min.js +18 -0
- data/bower_components/swagger-ui/dist/lib/jquery.slideto.min.js +1 -0
- data/bower_components/swagger-ui/dist/lib/jquery.wiggle.min.js +8 -0
- data/bower_components/swagger-ui/dist/lib/marked.js +1272 -0
- data/bower_components/swagger-ui/dist/lib/swagger-oauth.js +290 -0
- data/bower_components/swagger-ui/dist/lib/underscore-min.js +6 -0
- data/bower_components/swagger-ui/dist/lib/underscore-min.map +1 -0
- data/bower_components/swagger-ui/dist/o2c.html +20 -0
- data/bower_components/swagger-ui/dist/swagger-ui.js +32187 -0
- data/bower_components/swagger-ui/dist/swagger-ui.min.js +14 -0
- data/config/routes.rb +4 -0
- data/lib/generators/swagger_rails/custom_ui/USAGE +8 -0
- data/lib/generators/swagger_rails/custom_ui/custom_ui_generator.rb +9 -0
- data/lib/generators/swagger_rails/custom_ui/files/index.html.erb +145 -0
- data/lib/generators/swagger_rails/install/USAGE +9 -0
- data/lib/generators/swagger_rails/install/install_generator.rb +20 -0
- data/lib/generators/swagger_rails/install/templates/swagger.json +45 -0
- data/lib/generators/swagger_rails/install/templates/swagger_rails.rb +13 -0
- data/lib/swagger_rails/engine.rb +13 -0
- data/lib/swagger_rails/middleware/swagger_docs.rb +4 -0
- data/lib/swagger_rails/middleware/swagger_ui.rb +14 -0
- data/lib/swagger_rails/rspec/dsl.rb +63 -0
- data/lib/swagger_rails/rspec/formatter.rb +61 -0
- data/lib/swagger_rails/test_visitor.rb +59 -0
- data/lib/swagger_rails/version.rb +3 -0
- data/lib/swagger_rails.rb +24 -0
- data/lib/tasks/swagger_rails_tasks.rake +12 -0
- metadata +152 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: fbbe5654c93a933a0238d3727ea570c95578efc4
|
4
|
+
data.tar.gz: 400ddf26eb5d0eef9daed9341652c49307942f86
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 813fe6d095a303656cf97fe4804e5644482e8a106979dbf469c6fa7975e751e82568be60f0fa9a63279e5eaa000ca043b0e04708fe60450d70887c5eabd76931
|
7
|
+
data.tar.gz: 5d5d1f837cbabf9227a5926f76eba01e3976a243eb2dfcb23eec62b9ad249f7554ed993bdc78ab019a3bddd4b4f61043b0ec7c2aa8cfd166ae5179440568097b
|
data/MIT-LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright 2015 domaindrivendev
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
ADDED
data/Rakefile
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
begin
|
2
|
+
require 'bundler/setup'
|
3
|
+
rescue LoadError
|
4
|
+
puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
|
5
|
+
end
|
6
|
+
|
7
|
+
require 'rdoc/task'
|
8
|
+
|
9
|
+
RDoc::Task.new(:rdoc) do |rdoc|
|
10
|
+
rdoc.rdoc_dir = 'rdoc'
|
11
|
+
rdoc.title = 'SwaggerRails'
|
12
|
+
rdoc.options << '--line-numbers'
|
13
|
+
rdoc.rdoc_files.include('README.rdoc')
|
14
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
15
|
+
end
|
16
|
+
|
17
|
+
|
18
|
+
|
19
|
+
load 'rails/tasks/statistics.rake'
|
20
|
+
|
21
|
+
|
22
|
+
|
23
|
+
Bundler::GemHelper.install_tasks
|
24
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
module SwaggerRails
|
2
|
+
class SwaggerUiController < ApplicationController
|
3
|
+
|
4
|
+
def index
|
5
|
+
@discovery_paths = Hash[
|
6
|
+
SwaggerRails.swagger_docs.map do |path, doc|
|
7
|
+
[ "#{root_path}#{path}", doc[:info][:title] ]
|
8
|
+
end
|
9
|
+
]
|
10
|
+
|
11
|
+
render :index, layout: false
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,145 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="UTF-8">
|
5
|
+
<title>Swagger UI</title>
|
6
|
+
<link rel="icon" type="image/png" href="images/favicon-32x32.png" sizes="32x32" />
|
7
|
+
<link rel="icon" type="image/png" href="images/favicon-16x16.png" sizes="16x16" />
|
8
|
+
<link href='css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
|
9
|
+
<link href='css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
|
10
|
+
<link href='css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
|
11
|
+
<link href='css/reset.css' media='print' rel='stylesheet' type='text/css'/>
|
12
|
+
<link href='css/print.css' media='print' rel='stylesheet' type='text/css'/>
|
13
|
+
<script src='lib/jquery-1.8.0.min.js' type='text/javascript'></script>
|
14
|
+
<script src='lib/jquery.slideto.min.js' type='text/javascript'></script>
|
15
|
+
<script src='lib/jquery.wiggle.min.js' type='text/javascript'></script>
|
16
|
+
<script src='lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
|
17
|
+
<script src='lib/handlebars-2.0.0.js' type='text/javascript'></script>
|
18
|
+
<script src='lib/underscore-min.js' type='text/javascript'></script>
|
19
|
+
<script src='lib/backbone-min.js' type='text/javascript'></script>
|
20
|
+
<script src='swagger-ui.js' type='text/javascript'></script>
|
21
|
+
<script src='lib/highlight.7.3.pack.js' type='text/javascript'></script>
|
22
|
+
<script src='lib/marked.js' type='text/javascript'></script>
|
23
|
+
<script src='lib/swagger-oauth.js' type='text/javascript'></script>
|
24
|
+
|
25
|
+
<!-- Some basic translations -->
|
26
|
+
<!-- <script src='lang/translator.js' type='text/javascript'></script> -->
|
27
|
+
<!-- <script src='lang/ru.js' type='text/javascript'></script> -->
|
28
|
+
<!-- <script src='lang/en.js' type='text/javascript'></script> -->
|
29
|
+
|
30
|
+
<script type="text/javascript">
|
31
|
+
$(function () {
|
32
|
+
var url = window.location.search.match(/url=([^&]+)/);
|
33
|
+
if (url && url.length > 1) {
|
34
|
+
url = decodeURIComponent(url[1]);
|
35
|
+
} else {
|
36
|
+
url = "<%= @discovery_paths.keys.first %>";
|
37
|
+
}
|
38
|
+
|
39
|
+
// Pre load translate...
|
40
|
+
if(window.SwaggerTranslator) {
|
41
|
+
window.SwaggerTranslator.translate();
|
42
|
+
}
|
43
|
+
window.swaggerUi = new SwaggerUi({
|
44
|
+
url: url,
|
45
|
+
dom_id: "swagger-ui-container",
|
46
|
+
supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
|
47
|
+
onComplete: function(swaggerApi, swaggerUi){
|
48
|
+
if(typeof initOAuth == "function") {
|
49
|
+
initOAuth({
|
50
|
+
clientId: "your-client-id",
|
51
|
+
clientSecret: "your-client-secret",
|
52
|
+
realm: "your-realms",
|
53
|
+
appName: "your-app-name",
|
54
|
+
scopeSeparator: ","
|
55
|
+
});
|
56
|
+
}
|
57
|
+
|
58
|
+
if(window.SwaggerTranslator) {
|
59
|
+
window.SwaggerTranslator.translate();
|
60
|
+
}
|
61
|
+
|
62
|
+
$('pre code').each(function(i, e) {
|
63
|
+
hljs.highlightBlock(e)
|
64
|
+
});
|
65
|
+
|
66
|
+
addApiKeyAuthorization();
|
67
|
+
},
|
68
|
+
onFailure: function(data) {
|
69
|
+
log("Unable to Load SwaggerUI");
|
70
|
+
},
|
71
|
+
docExpansion: "list",
|
72
|
+
apisSorter: "alpha",
|
73
|
+
showRequestHeaders: false
|
74
|
+
});
|
75
|
+
|
76
|
+
function addApiKeyAuthorization(){
|
77
|
+
var key = encodeURIComponent($('#input_apiKey')[0].value);
|
78
|
+
if(key && key.trim() != "") {
|
79
|
+
var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("api_key", key, "query");
|
80
|
+
window.swaggerUi.api.clientAuthorizations.add("api_key", apiKeyAuth);
|
81
|
+
log("added key " + key);
|
82
|
+
}
|
83
|
+
}
|
84
|
+
|
85
|
+
$('#input_apiKey').change(addApiKeyAuthorization);
|
86
|
+
|
87
|
+
// if you have an apiKey you would like to pre-populate on the page for demonstration purposes...
|
88
|
+
/*
|
89
|
+
var apiKey = "myApiKeyXXXX123456789";
|
90
|
+
$('#input_apiKey').val(apiKey);
|
91
|
+
*/
|
92
|
+
|
93
|
+
window.swaggerUi.load();
|
94
|
+
|
95
|
+
function log() {
|
96
|
+
if ('console' in window) {
|
97
|
+
console.log.apply(console, arguments);
|
98
|
+
}
|
99
|
+
}
|
100
|
+
});
|
101
|
+
</script>
|
102
|
+
</head>
|
103
|
+
|
104
|
+
<body class="swagger-section">
|
105
|
+
<div id='header'>
|
106
|
+
<div class="swagger-ui-wrap">
|
107
|
+
<a id="logo" href="http://swagger.io">swagger</a>
|
108
|
+
<form id='api_selector'>
|
109
|
+
<div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text" disabled="disabled"/></div>
|
110
|
+
<div class='input'><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"/></div>
|
111
|
+
<div class='input'>
|
112
|
+
<select id="select_version">
|
113
|
+
<% @discovery_paths.each do |path, title| %>
|
114
|
+
<option value="<%= path %>"><%= title %></option>
|
115
|
+
<% end %>
|
116
|
+
</select>
|
117
|
+
<script type="text/javascript">
|
118
|
+
$('#select_version').change(function () {
|
119
|
+
$('#input_baseUrl').val($(this).val());
|
120
|
+
window.swaggerUi.headerView.showCustom();
|
121
|
+
});
|
122
|
+
</script>
|
123
|
+
<style>
|
124
|
+
#select_version {
|
125
|
+
border: none;
|
126
|
+
-moz-border-radius: 4px;
|
127
|
+
-webkit-border-radius: 4px;
|
128
|
+
-o-border-radius: 4px;
|
129
|
+
-ms-border-radius: 4px;
|
130
|
+
-khtml-border-radius: 4px;
|
131
|
+
border-radius: 4px;
|
132
|
+
color: white;
|
133
|
+
background-color: #547f00;
|
134
|
+
font-size: 0.9em;
|
135
|
+
}
|
136
|
+
</style>
|
137
|
+
</div>
|
138
|
+
</form>
|
139
|
+
</div>
|
140
|
+
</div>
|
141
|
+
|
142
|
+
<div id="message-bar" class="swagger-ui-wrap" data-sw-translate> </div>
|
143
|
+
<div id="swagger-ui-container" class="swagger-ui-wrap"></div>
|
144
|
+
</body>
|
145
|
+
</html>
|