15 Commits
2.0.0 ... 2.0.5

Author SHA1 Message Date
Richard Morris
5ea1670d79 Merge pull request #136 from ledermann/upgrade-swagger-ui-to-3-17-3
Upgrade Swagger UI to 3.17.3
2018-07-10 07:53:01 -07:00
Georg Ledermann
00aa08bb22 ⬆️ Upgrade "swagger-ui" to 3.17.3 2018-07-10 14:49:12 +02:00
Richard Morris
ef91e087d3 Update compatibility chart to reflect realty 2018-06-21 23:27:57 -07:00
Richard Morris
be6def33ac Merge pull request #134 from ledermann/upgrade-swagger-ui-to-3-17-1
Upgrade Swagger UI to 3.17.1
2018-06-21 07:34:15 -07:00
Georg Ledermann
6b04c72cc9 ⬆️ Upgrade "swagger-ui" to 3.17.1 2018-06-21 09:11:06 +02:00
Richard Morris
890a31e749 Merge pull request #129 from hoshinotsuyoshi/fix_typo_readme
Fix typo in README
2018-05-30 18:16:01 -07:00
hoshinotsuyoshi
862ea53cf4 Fix typo in README
Fixed Gemfile example.
2018-05-31 08:54:12 +09:00
Richard Morris
254ade95db Update README.md 2018-05-24 20:28:17 -07:00
Richard Morris
b9f71fe9b1 Merge pull request #117 from imRohan/master
Fixed typos in the swagger_helper.rb file
2018-05-24 20:00:10 -07:00
Richard Morris
870d467046 Merge pull request #125 from indocomsoft/patch-1
Fix travis to not cleanup when publishing rswag-ui
2018-05-24 19:59:56 -07:00
Julius Putra Tanu Setiaji
334671cb95 Fix travis to not cleanup when publishing rswag-ui
This is to keep `node_modules` directory.
2018-05-25 10:05:48 +08:00
domaindrivendev
efdfee5110 Tweak rswag-ui.gemspec to include node_modules 2018-05-24 09:31:06 -07:00
domaindrivendev
0c49c7e667 Ensure npm install runs during the deploy rswag-ui job 2018-05-24 08:58:19 -07:00
Richard Morris
e52ea0ba69 Update readme 2018-05-21 16:18:30 -07:00
Rohan Likhite
fee3b3bb84 fixed typos in the swagger_helper.rb file 2018-03-29 11:42:36 -04:00
7 changed files with 13 additions and 12 deletions

View File

@@ -49,6 +49,7 @@ jobs:
gemspec: rswag-ui.gemspec gemspec: rswag-ui.gemspec
provider: rubygems provider: rubygems
api_key: $RUBYGEMS_API_KEY api_key: $RUBYGEMS_API_KEY
skip_cleanup: true
on: on:
branch: master branch: master
tags: true tags: true

View File

@@ -1,4 +1,4 @@
rswag (formerly swagger_rails) rswag
========= =========
[![Build Status](https://travis-ci.org/domaindrivendev/rswag.svg?branch=master)](https://travis-ci.org/domaindrivendev/rswag) [![Build Status](https://travis-ci.org/domaindrivendev/rswag.svg?branch=master)](https://travis-ci.org/domaindrivendev/rswag)
@@ -14,8 +14,8 @@ Once you have an API that can describe itself in Swagger, you've opened the trea
|Rswag Version|Swagger (OpenAPI) Spec.|swagger-ui| |Rswag Version|Swagger (OpenAPI) Spec.|swagger-ui|
|----------|----------|----------| |----------|----------|----------|
|[master](https://github.com/domaindrivendev/rswag/tree/master)|2.0|3.13.2| |[master](https://github.com/domaindrivendev/rswag/tree/master)|2.0|3.17.3|
|[2.0.0](https://github.com/domaindrivendev/rswag/tree/2.0.0)|2.0|3.13.2| |[2.0.4](https://github.com/domaindrivendev/rswag/tree/2.0.4)|2.0|3.17.1|
|[1.6.0](https://github.com/domaindrivendev/rswag/tree/1.6.0)|2.0|2.2.5| |[1.6.0](https://github.com/domaindrivendev/rswag/tree/1.6.0)|2.0|2.2.5|
## Getting Started ## ## Getting Started ##
@@ -33,7 +33,7 @@ Once you have an API that can describe itself in Swagger, you've opened the trea
gem 'rswag-api' gem 'rswag-api'
gem 'rswag-ui' gem 'rswag-ui'
groups :test do group :test do
gem 'rspec-rails' gem 'rspec-rails'
gem 'rswag-specs' gem 'rswag-specs'
end end
@@ -494,7 +494,7 @@ rails g rswag:ui:custom
This will add a local version that you can modify at _app/views/rswag/ui/home/index.html.erb_ This will add a local version that you can modify at _app/views/rswag/ui/home/index.html.erb_
### Publish UI Assets with "assets:precompile: ### Serve UI Assets Directly from your Web Server
Rswag ships with an embedded version of the [swagger-ui](https://github.com/swagger-api/swagger-ui), which is a static collection of JavaScript and CSS files. These assets are served by the rswag-ui middleware. However, for optimal performance you may want to serve them directly from your web server (e.g. Apache or NGINX). To do this, you'll need to copy them to the web server root. This is the "public" folder in a typical Rails application. Rswag ships with an embedded version of the [swagger-ui](https://github.com/swagger-api/swagger-ui), which is a static collection of JavaScript and CSS files. These assets are served by the rswag-ui middleware. However, for optimal performance you may want to serve them directly from your web server (e.g. Apache or NGINX). To do this, you'll need to copy them to the web server root. This is the "public" folder in a typical Rails application.

View File

@@ -3,7 +3,7 @@ require 'rails_helper'
RSpec.configure do |config| RSpec.configure do |config|
# Specify a root folder where Swagger JSON files are generated # Specify a root folder where Swagger JSON files are generated
# NOTE: If you're using the rswag-api to serve API descriptions, you'll need # NOTE: If you're using the rswag-api to serve API descriptions, you'll need
# to ensure that it's confiugred to server Swagger from the same folder # to ensure that it's configured to serve Swagger from the same folder
config.swagger_root = Rails.root.to_s + '/swagger' config.swagger_root = Rails.root.to_s + '/swagger'
# Define one or more Swagger documents and provide global metadata for each one # Define one or more Swagger documents and provide global metadata for each one

View File

@@ -5,9 +5,9 @@
"requires": true, "requires": true,
"dependencies": { "dependencies": {
"swagger-ui-dist": { "swagger-ui-dist": {
"version": "3.13.2", "version": "3.17.3",
"resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.13.2.tgz", "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.17.3.tgz",
"integrity": "sha1-EL9SK9J0q2SU0r0Nuvn+2ibbHKI=" "integrity": "sha1-37lkCMzEZ3UVX3NpGQxdSyAW/lw="
} }
} }
} }

View File

@@ -3,6 +3,6 @@
"version": "1.0.0", "version": "1.0.0",
"private": true, "private": true,
"dependencies": { "dependencies": {
"swagger-ui-dist": "3.13.2" "swagger-ui-dist": "3.17.3"
} }
} }

View File

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
s.description = "Expose beautiful API documentation, that's powered by Swagger JSON endpoints, including a UI to explore and test operations" s.description = "Expose beautiful API documentation, that's powered by Swagger JSON endpoints, including a UI to explore and test operations"
s.license = "MIT" s.license = "MIT"
s.files = Dir["{lib,node_modules}/**/*"] + ["MIT-LICENSE", "Rakefile" ] s.files = Dir.glob("{lib,node_modules}/**/*") + ["MIT-LICENSE", "Rakefile" ]
s.add_dependency 'actionpack', '>=3.1', '< 6.0' s.add_dependency 'actionpack', '>=3.1', '< 6.0'
s.add_dependency 'railties', '>= 3.1', '< 6.0' s.add_dependency 'railties', '>= 3.1', '< 6.0'

View File

@@ -3,7 +3,7 @@ require 'rails_helper'
RSpec.configure do |config| RSpec.configure do |config|
# Specify a root folder where Swagger JSON files are generated # Specify a root folder where Swagger JSON files are generated
# NOTE: If you're using the rswag-api to serve API descriptions, you'll need # NOTE: If you're using the rswag-api to serve API descriptions, you'll need
# to ensure that it's confiugred to server Swagger from the same folder # to ensure that it's configured to serve Swagger from the same folder
config.swagger_root = Rails.root.to_s + '/swagger' config.swagger_root = Rails.root.to_s + '/swagger'
# Define one or more Swagger documents and provide global metadata for each one # Define one or more Swagger documents and provide global metadata for each one