Skip to content

Swagger Improvements #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 24, 2016
Merged

Swagger Improvements #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd4bddc
Ensure swagger.json is valid
May 21, 2016
70ab5b0
Merge branch 'master' into swagger-fixes
May 21, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ env:
- TEST_STEP=lint
- TEST_STEP=flow
- TEST_STEP=test
- TEST_STEP=swagger
notifications:
email: false
46 changes: 32 additions & 14 deletions lib/swagger/paths.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
"use strict";
var swaggerPaths = module.exports = { };
var jsonApi = require("../../");
var _ = {
uniq: require("lodash.uniq")
};


swaggerPaths.getPathDefinitions = function() {
Expand Down Expand Up @@ -40,31 +43,36 @@ swaggerPaths._addBasicPaths = function(paths, resourceName, resourceConfig) {
handler: "search",
resourceName: resourceName,
description: "Search for " + resourceName,
parameters: resourceConfig.searchParams
parameters: resourceConfig.searchParams,
hasPathId: false
Copy link
Contributor Author

@theninj4 theninj4 May 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of these hasPathId params correspond to if the URL contains /{id}/.

}),
post: swaggerPaths._getPathOperationObject({
handler: "create",
resourceName: resourceName,
description: "Create a new instance of " + resourceName,
parameters: resourceConfig.attributes
parameters: resourceConfig.attributes,
hasPathId: false
})
};

paths["/" + resourceName + "/{id}"] = {
get: swaggerPaths._getPathOperationObject({
handler: "find",
resourceName: resourceName,
description: "Get a specific instance of " + resourceName
description: "Get a specific instance of " + resourceName,
hasPathId: true
}),
delete: swaggerPaths._getPathOperationObject({
handler: "delete",
resourceName: resourceName,
description: "Delete an instance of " + resourceName
description: "Delete an instance of " + resourceName,
hasPathId: true
}),
patch: swaggerPaths._getPathOperationObject({
handler: "update",
resourceName: resourceName,
description: "Update an instance of " + resourceName
description: "Update an instance of " + resourceName,
hasPathId: true
})
};
};
Expand All @@ -73,7 +81,8 @@ swaggerPaths._addDeepPaths = function(paths, resourceName, resourceConfig, relat
paths["/" + resourceName + "/{id}/" + relationName] = {
get: swaggerPaths._getPathOperationObject({
handler: "find",
resourceName: relation
resourceName: relation,
hasPathId: true
})
};

Expand All @@ -83,25 +92,29 @@ swaggerPaths._addDeepPaths = function(paths, resourceName, resourceConfig, relat
handler: "find",
resourceName: relation,
relationType: relationType,
extraTags: resourceName
extraTags: resourceName,
hasPathId: true
}),
post: swaggerPaths._getPathOperationObject({
handler: "create",
resourceName: relation,
relationType: relationType,
extraTags: resourceName
extraTags: resourceName,
hasPathId: true
}),
patch: swaggerPaths._getPathOperationObject({
handler: "update",
resourceName: relation,
relationType: relationType,
extraTags: resourceName
extraTags: resourceName,
hasPathId: true
}),
delete: swaggerPaths._getPathOperationObject({
handler: "delete",
resourceName: relation,
relationType: relationType,
extraTags: resourceName
extraTags: resourceName,
hasPathId: true
})
};
};
Expand All @@ -116,7 +129,7 @@ swaggerPaths._getPathOperationObject = function(options) {
description: options.resourceName + " " + options.handler + " response",
schema: {
type: "object",
required: [ "jsonapi", "meta, links" ],
required: [ "jsonapi", "meta", "links" ],
Copy link
Contributor Author

@theninj4 theninj4 May 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was originally a typo... Oops?

properties: {
jsonapi: {
type: "object",
Expand Down Expand Up @@ -164,6 +177,7 @@ swaggerPaths._getPathOperationObject = function(options) {
};
if (options.extraTags) {
pathDefinition.tags = pathDefinition.tags.concat(options.extraTags);
pathDefinition.tags = _.uniq(pathDefinition.tags);
Copy link
Contributor Author

@theninj4 theninj4 May 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This ensures all tags are unique and prevents us from having [ "a", "a" ].

}

var responseShortcut = pathDefinition.responses["200"].schema.properties;
Expand All @@ -180,7 +194,10 @@ swaggerPaths._getPathOperationObject = function(options) {
if (((options.handler === "search") || (options.handler === "find")) && !options.relation) {
pathDefinition.parameters = pathDefinition.parameters.concat(swaggerPaths._optionalJsonApiParameters());
responseShortcut.included = {
type: "array"
type: "array",
items: {
type: "object"
}
Copy link
Contributor Author

@theninj4 theninj4 May 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the definition for what should appear in the included block on any request supporting inclusions. I've set it to simply be an object for now - it seems like overkill to say this could be any resource in the swagger doc.

};
}

Expand Down Expand Up @@ -214,7 +231,7 @@ swaggerPaths._getPathOperationObject = function(options) {
pathDefinition.responses["200"] = undefined;
}

if ((options.handler !== "search") && (options.handler !== "create")) {
if (options.hasPathId) {
Copy link
Contributor Author

@theninj4 theninj4 May 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we create the path operation objects, we now pass in hasPathId which reflects if the URL contains a /{id}/ parameter. We used to guess based on the operation, but it wasn't specific enough for all edge cases.

pathDefinition.parameters.push({
name: "id",
in: "path",
Expand Down Expand Up @@ -258,7 +275,8 @@ swaggerPaths._optionalJsonApiParameters = function() {
{ "$ref": "#/parameters/sort" },
{ "$ref": "#/parameters/include" },
{ "$ref": "#/parameters/filter" },
{ "$ref": "#/parameters/fields" }
{ "$ref": "#/parameters/fields" },
{ "$ref": "#/parameters/page" }
Copy link
Contributor Author

@theninj4 theninj4 May 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This adds the page= url param to optionally appear pretty much anywhere.

];
};

Expand Down
9 changes: 4 additions & 5 deletions lib/swagger/resources.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,10 @@ swaggerPaths._getResourceDefinition = function(resourceConfig) {
},
"attributes": {
type: "object",
required: [ ],
properties: { }
},
"relationships": {
type: "object",
required: [ ],
properties: { }
},
Copy link
Contributor Author

@theninj4 theninj4 May 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're not allowed to have empty required arrays.

"links": {
Expand Down Expand Up @@ -74,9 +72,10 @@ swaggerPaths._getResourceDefinition = function(resourceConfig) {
}
attributeShortcut[attribute] = swaggerScheme;

// if ((joiScheme._flags || { }).presence === "required") {
// resourceDefinition.properties.attributes.required.push(attribute);
// }
if ((joiScheme._flags || { }).presence === "required") {
resourceDefinition.properties.attributes.required = resourceDefinition.properties.attributes.required || [ ];
resourceDefinition.properties.attributes.required.push(attribute);
}
Copy link
Contributor Author

@theninj4 theninj4 May 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This block used to give us troubles with our test suite, especially around queries that use the fields= parameter to opt-out of seeing required attributes. I've fixed the tests and this can go back in. Required fields now appear correctly in the swagger doc.

} else {
if (joiScheme._settings.as) continue;

Expand Down
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"mocha-performance": "0.1.0",
"node-inspector": "0.12.5",
"plato": "1.5.0",
"swagger-tools": "^0.10.1",
"v8-profiler": "5.5.0"
},
"scripts": {
Expand All @@ -56,7 +57,8 @@
"performance": "node --allow-natives-syntax --harmony ./node_modules/mocha/bin/_mocha -S --reporter mocha-performance ./test/*.js",
"lint": "node ./node_modules/eslint/bin/eslint ./example ./lib ./test --quiet && echo '✔ All good!'",
"jscpd": "jscpd --blame -p ./lib/ || echo 'Finished!'",
"flow": "node ./node_modules/flow-bin/cli.js && echo '✔ All good!'"
"flow": "node ./node_modules/flow-bin/cli.js && echo '✔ All good!'",
"swagger": "node ./node_modules/mocha/bin/mocha -S -R spec ./swaggerValidator.js --timeout 60000"
},
"config": {
"blanket": {
Expand Down
48 changes: 48 additions & 0 deletions swaggerValidator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
"use strict";
var jsonApiTestServer = require("./example/server.js");
var request = require("request");
var assert = require("assert");

describe("Use a tool to validate the generated swagger document", function() {
it("should not contain any errors", function(done) {
var validator = require("swagger-tools").specs.v2;

var uri = "http://localhost:16006/rest/swagger.json";
request(uri, function(meh, res, swaggerObject) {
swaggerObject = JSON.parse(swaggerObject);

validator.validate(swaggerObject, function (err, result) {
assert.ifError(err);

if (!result) {
console.log("Swagger document is valid");
return done();
}

if (result.errors.length > 0) {
console.log("The Swagger document is invalid...");
console.log("");
console.log("Errors");
console.log("------");
console.log(result.errors);
console.log("");
}

if (result.warnings.length > 0) {
console.log("Warnings");
console.log("--------");
console.log(result.warnings);
}

done(new Error("Invalid swagger.json!"));
});
});
});

before(function() {
jsonApiTestServer.start();
});
after(function() {
jsonApiTestServer.close();
});
});
3 changes: 2 additions & 1 deletion test/get-resource-id.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"use strict";
var assert = require("assert");
var helpers = require("./helpers.js");
var request = require("request");
var jsonApiTestServer = require("../example/server.js");


Expand Down Expand Up @@ -38,7 +39,7 @@ describe("Testing jsonapi-server", function() {

it("with fields", function(done) {
var url = "http://localhost:16006/rest/articles/de305d54-75b4-431b-adb2-eb6b9e546014?fields[articles]=title";
helpers.request({
request({
Copy link
Contributor Author

@theninj4 theninj4 May 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

helpers.request is a wrapper around request that also validates the request + response against the swagger definition. The fields JSON:API attribute allows us to bypass the required attributes on the models, so I've had to opt a bunch of these tests out of those assertions.

method: "GET",
url: url
}, function(err, res, json) {
Expand Down
5 changes: 3 additions & 2 deletions test/get-resource.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"use strict";
var assert = require("assert");
var helpers = require("./helpers.js");
var request = require("request");
var jsonApiTestServer = require("../example/server.js");


Expand Down Expand Up @@ -365,7 +366,7 @@ describe("Testing jsonapi-server", function() {

it("just title", function(done) {
var url = "http://localhost:16006/rest/articles?fields[articles]=title";
helpers.request({
request({
method: "GET",
url: url
}, function(err, res, json) {
Expand All @@ -384,7 +385,7 @@ describe("Testing jsonapi-server", function() {

it("title AND content", function(done) {
var url = "http://localhost:16006/rest/articles?fields[articles]=title,content";
helpers.request({
request({
method: "GET",
url: url
}, function(err, res, json) {
Expand Down
2 changes: 1 addition & 1 deletion test/patch-resource-id.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ describe("Testing jsonapi-server", function() {
}
})
};
helpers.request(data, function(err, res, json) {
request(data, function(err, res, json) {
assert.equal(err, null);
json = helpers.validateJson(json);

Expand Down
2 changes: 1 addition & 1 deletion test/post-resource.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ describe("Testing jsonapi-server", function() {
}
})
};
helpers.request(data, function(err, res, json) {
request(data, function(err, res, json) {
assert.equal(err, null);
json = helpers.validateError(json);
assert.equal(json.errors[0].detail.length, 2, "Expecting several validation errors");
Expand Down