mirror of
https://github.com/ditkrg/rswag.git
synced 2026-01-23 06:16:42 +00:00
Add some comments to swagger_rails initializer
This commit is contained in:
parent
63861a3940
commit
0cf86cb5bf
@ -82,7 +82,7 @@ GEM
|
|||||||
rake (10.4.2)
|
rake (10.4.2)
|
||||||
rdoc (3.12.2)
|
rdoc (3.12.2)
|
||||||
json (~> 1.4)
|
json (~> 1.4)
|
||||||
rspec-core (3.4.1)
|
rspec-core (3.4.4)
|
||||||
rspec-support (~> 3.4.0)
|
rspec-support (~> 3.4.0)
|
||||||
rspec-expectations (3.4.0)
|
rspec-expectations (3.4.0)
|
||||||
diff-lcs (>= 1.2.0, < 2.0)
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
|
|||||||
@ -1,6 +1,7 @@
|
|||||||
SwaggerRails.configure do |c|
|
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
|
c.swagger_doc 'v1/swagger.json' do
|
||||||
{
|
{
|
||||||
info: {
|
info: {
|
||||||
|
|||||||
@ -1,6 +1,7 @@
|
|||||||
SwaggerRails.configure do |c|
|
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
|
c.swagger_doc 'v1/swagger.json' do
|
||||||
{
|
{
|
||||||
info: {
|
info: {
|
||||||
|
|||||||
@ -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"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -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
|
response '201', 'valid request' do
|
||||||
|
let(:blog) { { title: 'foo', content: 'bar' } }
|
||||||
run_test!
|
run_test!
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user