ditkrg/rswag
4
0
Fork 0
mirror of https://github.com/ditkrg/rswag.git synced 2026-01-22 22:06:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some comments to swagger_rails initializer

Browse Source
This commit is contained in:
domaindrivendev 2016-04-06 17:19:54 -07:00
parent 63861a3940
commit 0cf86cb5bf
5 changed files with 6 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Gemfile.lock
View File

@ -82,7 +82,7 @@ GEM
rake (10.4.2)
rdoc (3.12.2)
json (~> 1.4)
rspec-core (3.4.1)
rspec-core (3.4.4)
rspec-support (~> 3.4.0)
rspec-expectations (3.4.0)
diff-lcs (>= 1.2.0, < 2.0)

3
lib/generators/swagger_rails/install/templates/swagger_rails.rb
View File

@ -1,6 +1,7 @@
SwaggerRails.configure do |c|
# Define the swagger documents you'd like to expose and provide global metadata
# Define your swagger documents and provide global metadata
# Describe actual operations in your spec/test files
c.swagger_doc 'v1/swagger.json' do
{
info: {

3
spec/dummy/config/initializers/swagger_rails.rb
View File

@ -1,6 +1,7 @@
SwaggerRails.configure do |c|
# Define the swagger documents you'd like to expose and provide global metadata
# Define your swagger documents and provide global metadata
# Describe actual operations in your spec/test files
c.swagger_doc 'v1/swagger.json' do
{
info: {

79
spec/dummy/config/swagger/v1/swagger.json
View File

@ -1,79 +0,0 @@
{
"swagger": "2.0",
"info": {
"title": "API V1",
"version": "v1"
},
"paths": {
"/blogs": {
"post": {
"summary": "creates a new blog",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "blog",
"in": "body",
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"content": {
"type": "string"
}
}
}
}
],
"responses": {
"201": {
"description": "valid request"
},
"422": {
"description": "invalid request"
}
}
},
"get": {
"summary": "searches existing blogs",
"produces": [
"application/json"
],
"parameters": [
],
"responses": {
"200": {
"description": "valid request"
}
}
}
},
"/blogs/{id}": {
"get": {
"summary": "retreives a specific blog",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"type": "string"
}
],
"responses": {
"200": {
"description": "blog found"
}
}
}
}
}
}

3
spec/dummy/spec/integration/blogs_spec.rb
View File

@ -15,9 +15,8 @@ describe 'Blogs API', docs_path: 'blogs/v1/swagger.json' do
}
}
let(:blog) { { title: 'foo', content: 'bar' } }
response '201', 'valid request' do
let(:blog) { { title: 'foo', content: 'bar' } }
run_test!
end